--git url--branch branchBranch to use when adding from git.
\n--tag tagTag to use when adding from git.
\n--rev shaSpecific commit to use when adding from git.
\n--path pathFilesystem path to local crate to add.
\n--base baseThe path base to use when adding a local crate.
\n\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
--devAdd as a development dependency.
\n--buildAdd as a build dependency.
\n--target targetAdd as a dependency to the given target platform.
\nTo avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.
--dry-runDon’t actually write the manifest
\n--rename nameRename the dependency.
\n--optionalMark the dependency as optional.
\n--no-optionalMark the dependency as required.
\n--publicMark the dependency as public.
\nThe dependency can be referenced in your library’s public API.
\n\n--no-publicMark the dependency as private.
\nWhile you can use the crate in your implementation, it cannot be referenced in your public API.
\n\n--no-default-featuresDisable the default features.
\n--default-featuresRe-enable the default features.
\n-F features--features featuresSpace or comma separated list of features to\nactivate. When adding multiple\ncrates, the features for a specific crate may be enabled with\npackage-name/feature-name syntax. This flag may be specified multiple times,\nwhich enables all specified features.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
-p spec--package specAdd dependencies to only the specified package.
\n--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-runCompile, but don’t run benchmarks.
\n--no-fail-fastRun all benchmarks regardless of failure. Without this flag, Cargo will exit\nafter the first executable fails. The Rust test harness will run all benchmarks\nwithin the executable to completion, this flag only applies to the executable\nas a whole.
\n-p spec…--package spec…Benchmark only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceBenchmark all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libBenchmark the package’s library.
\n--bin name…Benchmark the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBenchmark all binary targets.
\n--example name…Benchmark the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBenchmark all example targets.
\n--test name…Benchmark the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBenchmark all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Benchmark the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBenchmark all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBenchmark all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBenchmark for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--profile nameBenchmark with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
-p spec…--package spec…Build only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceBuild all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libBuild the package’s library.
\n--bin name…Build the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBuild all binary targets.
\n--example name…Build the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBuild all example targets.
\n--test name…Build the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBuild all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Build the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBuild all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBuild all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBuild for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseBuild optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameBuild with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
--artifact-dir directoryCopy final artifacts to this directory.
\nThis option is unstable and available only on the\nnightly channel\nand requires the -Z unstable-options flag to enable.\nSee https://github.com/rust-lang/cargo/issues/6790 for more information.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo build -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo build -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-p spec…--package spec…Check only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceCheck all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libCheck the package’s library.
\n--bin name…Check the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsCheck all binary targets.
\n--example name…Check the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesCheck all example targets.
\n--test name…Check the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsCheck all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Check the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesCheck all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsCheck all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleCheck for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseCheck optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameCheck with the given profile.
\nAs a special case, specifying the test profile will also enable checking in\ntest mode which will enable checking tests and enable the test cfg option.\nSee rustc tests for more\ndetail.
See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo check -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo check -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-p spec…--package spec…Clean only the specified packages. This flag may be specified\nmultiple times. See cargo-pkgid(1) for the SPEC format.
\n--workspaceClean artifacts of the workspace members.
\n--dry-runDisplays a summary of what would be deleted without deleting anything.\nUse with --verbose to display the actual files that would be deleted.
--docThis option will cause cargo clean to remove only the doc directory in\nthe target directory.
--releaseRemove artifacts only in the release directory.
--profile nameRemove artifacts only in the directory with the given profile name.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
--target tupleClean for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--openOpen the docs in a browser after building them. This will use your default\nbrowser unless you define another one in the BROWSER environment variable\nor use the doc.browser configuration\noption.
--no-depsDo not build documentation for dependencies.
\n--document-private-itemsInclude non-public items in the documentation. This will be enabled by default if documenting a binary target.
\n-p spec…--package spec…Document only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceDocument all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libDocument the package’s library.
\n--bin name…Document the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsDocument all binary targets.
\n--example name…Document the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesDocument all example targets.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleDocument for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseDocument optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameDocument with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo doc -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo doc -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--output-formatThe output type for the documentation emitted. Valid values:
\nhtml (default): Emit the documentation in HTML format.json: Emit the documentation in the experimental JSON format.This option is only available on the nightly channel\nand requires the -Z unstable-options flag to enable.
--target tupleFetch for the specified target architecture. Flag may be specified multiple times. The default is all architectures. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--broken-codeFix code even if it already has compiler errors. This is useful if cargo fix\nfails to apply the changes. It will apply the changes and leave the broken\ncode in the working directory for you to inspect and manually fix.
--editionApply changes that will update the code to the next edition. This will not\nupdate the edition in the Cargo.toml manifest, which must be updated\nmanually after cargo fix --edition has finished.
--edition-idiomsApply suggestions that will update code to the preferred style for the current\nedition.
\n--allow-no-vcsFix code even if a VCS was not detected.
\n--allow-dirtyFix code even if the working directory has changes (including staged changes).
\n--allow-stagedFix code even if the working directory has staged changes.
\n-p spec…--package spec…Fix only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceFix all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libFix the package’s library.
\n--bin name…Fix the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsFix all binary targets.
\n--example name…Fix the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesFix all example targets.
\n--test name…Fix the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsFix all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Fix the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesFix all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsFix all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleFix for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseFix optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameFix with the given profile.
\nAs a special case, specifying the test profile will also enable checking in\ntest mode which will enable checking tests and enable the test cfg option.\nSee rustc tests for more\ndetail.
See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo fix -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo fix -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--publish-time yyyy-mm-ddThh:mm:ssZLatest publish time allowed for registry packages (Unstable)
\nThis is a best-effort filter on allowed packages, including:
\n--publish-time--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
Fetch information about the specified package. The spec can be a package ID, see cargo-pkgid(1) for the SPEC\nformat.\nIf the specified package is part of the current workspace, information from the local Cargo.toml file will be displayed.\nIf the Cargo.lock file does not exist, it will be created. If no version is specified, the appropriate version will be\nselected based on the Minimum Supported Rust Version (MSRV).
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--binCreate a package with a binary target (src/main.rs).\nThis is the default behavior.
--libCreate a package with a library target (src/lib.rs).
--edition editionSpecify the Rust edition to use. Default is 2024.\nPossible values: 2015, 2018, 2021, 2024
\n--name nameSet the package name. Defaults to the directory name.
\n--vcs vcsInitialize a new VCS repository for the given version control system (git,\nhg, pijul, or fossil) or do not initialize any version control at all\n(none). If not specified, defaults to git or the configuration value\ncargo-new.vcs, or none if already inside a VCS repository.
--registry registryThis sets the publish field in Cargo.toml to the given registry name\nwhich will restrict publishing only to that registry.
Registry names are defined in Cargo config files.\nIf not specified, the default registry defined by the registry.default\nconfig key is used. If the default registry is not set and --registry is not\nused, the publish field will not be set which means that publishing will not\nbe restricted.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--vers version--version versionSpecify a version to install. This may be a version\nrequirement, like ~1.2, to have Cargo\nselect the newest version from the given requirement. If the version does not\nhave a requirement operator (such as ^ or ~), then it must be in the form\nMAJOR.MINOR.PATCH, and will install exactly that version; it is not\ntreated as a caret requirement like Cargo dependencies are.
--git urlGit URL to install the specified crate from.
\n--branch branchBranch to use when installing from git.
\n--tag tagTag to use when installing from git.
\n--rev shaSpecific commit to use when installing from git.
\n--path pathFilesystem path to local crate to install from.
\n--listList all installed packages and their versions.
\n-n--dry-run(unstable) Perform all checks without installing.
\n-f--forceForce overwriting existing crates or binaries. This can be used if a package\nhas installed a binary with the same name as another package. This is also\nuseful if something has changed on the system that you want to rebuild with,\nsuch as a newer version of rustc.
--no-trackBy default, Cargo keeps track of the installed packages with a metadata file\nstored in the installation root directory. This flag tells Cargo not to use or\ncreate that file. With this flag, Cargo will refuse to overwrite any existing\nfiles unless the --force flag is used. This also disables Cargo’s ability to\nprotect against multiple concurrent invocations of Cargo installing at the\nsame time.
--bin name…Install only the specified binary.
\n--binsInstall all binaries. This is the default behavior.
\n--example name…Install only the specified example.
\n--examplesInstall all examples.
\n--root dirDirectory to install packages into.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
--index indexThe URL of the registry index to use.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleInstall for the specified target architecture. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to a new temporary folder located in the\ntemporary directory of the platform.
When using --path, by default it will use target directory in the workspace\nof the local crate unless --target-dir\nis specified.
--debugBuild with the debug profile instead of the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameInstall with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo install -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo install -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--workspaceLocate the Cargo.toml at the root of the workspace, as opposed to the current\nworkspace member.
--message-format fmtThe representation in which to print the project location. Valid values:
\njson (default): JSON object with the path under the key “root”.plain: Just the path.-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-depsOutput information only about the workspace members and don’t fetch\ndependencies.
\n--format-version versionSpecify the version of the output format to use. Currently 1 is the only\npossible value.
--filter-platform tupleThis filters the resolve output to only include dependencies for the\ngiven target tuple.\nA literal \"host-tuple\" can be used, which will internally be substituted by the host’s target.\nWithout this flag, the resolve includes all targets.
Note that the dependencies listed in the “packages” array still includes all\ndependencies. Each package definition is intended to be an unaltered\nreproduction of the information within Cargo.toml.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--binCreate a package with a binary target (src/main.rs).\nThis is the default behavior.
--libCreate a package with a library target (src/lib.rs).
--edition editionSpecify the Rust edition to use. Default is 2024.\nPossible values: 2015, 2018, 2021, 2024
\n--name nameSet the package name. Defaults to the directory name.
\n--vcs vcsInitialize a new VCS repository for the given version control system (git,\nhg, pijul, or fossil) or do not initialize any version control at all\n(none). If not specified, defaults to git or the configuration value\ncargo-new.vcs, or none if already inside a VCS repository.
--registry registryThis sets the publish field in Cargo.toml to the given registry name\nwhich will restrict publishing only to that registry.
Registry names are defined in Cargo config files.\nIf not specified, the default registry defined by the registry.default\nconfig key is used. If the default registry is not set and --registry is not\nused, the publish field will not be set which means that publishing will not\nbe restricted.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-a--add login…Invite the given user or team as an owner.
\n-r--remove login…Remove the given user or team as an owner.
\n-l--listList owners of a crate.
\n--token tokenAPI token to use when authenticating. This overrides the token stored in\nthe credentials file (which is created by cargo-login(1)).
\nCargo config environment variables can be\nused to override the tokens stored in the credentials file. The token for\ncrates.io may be specified with the CARGO_REGISTRY_TOKEN environment\nvariable. Tokens for other registries may be specified with environment\nvariables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME is the name\nof the registry in all capital letters.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-l--listPrint files included in a package without making one.
\n--no-verifyDon’t verify the contents by building them.
\n--no-metadataIgnore warnings about a lack of human-usable metadata (such as the description\nor the license).
\n--allow-dirtyAllow working directories with uncommitted VCS changes to be packaged.
\n--exclude-lockfileDon’t include the lock file when packaging.
\nThis flag is not for general use.\nSome tools may expect a lock file to be present (e.g. cargo install --locked).\nConsider other options before using this.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to package for; see cargo publish --help for more details\nabout configuration of registry names. The packages will not be published\nto this registry, but if we are packaging multiple inter-dependent crates,\nlock-files will be generated under the assumption that dependencies will be\npublished to this registry.
--message-format fmtSpecifies the output message format.\nCurrently, it only works with --list and affects the file listing format.\nThis is unstable and requires -Zunstable-options.\nValid output formats:
human (default): Display in a file-per-line format.json: Emit machine-readable JSON information about each package.\nOne package per JSON line (Newline delimited JSON).\n{\n /* The Package ID Spec of the package. */\n \"id\": \"path+file:///home/foo#0.0.0\",\n /* Files of this package */\n \"files\" {\n /* Relative path in the archive file. */\n \"Cargo.toml.orig\": {\n /* Where the file is from.\n - \"generate\" for file being generated during packaging\n - \"copy\" for file being copied from another location.\n */\n \"kind\": \"copy\",\n /* For the \"copy\" kind,\n it is an absolute path to the actual file content.\n For the \"generate\" kind,\n it is the original file the generated one is based on.\n */\n \"path\": \"/home/foo/Cargo.toml\"\n },\n \"Cargo.toml\": {\n \"kind\": \"generate\",\n \"path\": \"/home/foo/Cargo.toml\"\n },\n \"src/main.rs\": {\n \"kind\": \"copy\",\n \"path\": \"/home/foo/src/main.rs\"\n }\n }\n}\n-p spec…--package spec…Package only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspacePackage all members in the workspace.
\n--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--target tuplePackage for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo package -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo package -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p spec--package specGet the package ID for the given package instead of the current package.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--dry-runPerform all checks without uploading.
\n--no-verifyDon’t verify the contents by building them.
\n--allow-dirtyAllow working directories with uncommitted VCS changes to be packaged.
\n--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to publish to. Registry names are defined in Cargo\nconfig files. If not specified, and there is a\npackage.publish field in\nCargo.toml with a single registry, then it will publish to that registry.\nOtherwise it will use the default registry, which is defined by the\nregistry.default config key\nwhich defaults to crates-io.
-p spec…--package spec…Publish only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspacePublish all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--target tuplePublish for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo publish -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo publish -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--devRemove as a development dependency.
\n--buildRemove as a build dependency.
\n--target targetRemove as a dependency to the given target platform.
\nTo avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.
--dry-runDon’t actually write to the manifest.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-p spec…--package spec…Package to remove from.
\n+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--id idShow the report with the specified Cargo-generated id.\nIf not specified, shows the most recent report.
\n-p spec--package specThe package to display a report for. See cargo-pkgid(1) for the SPEC\nformat.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p spec--package specThe package to run. See cargo-pkgid(1) for the SPEC\nformat.
\n--bin nameRun the specified binary.
\n--example nameRun the specified example.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleRun for the specified target architecture. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseRun optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameRun with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo run -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo run -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-p spec--package specThe package to build. See cargo-pkgid(1) for the SPEC\nformat.
\n--libBuild the package’s library.
\n--bin name…Build the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBuild all binary targets.
\n--example name…Build the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBuild all example targets.
\n--test name…Build the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBuild all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Build the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBuild all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBuild all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBuild for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseBuild optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameBuild with the given profile.
\nThe rustc subcommand will treat the following named profiles with special behaviors:
check — Builds in the same way as the cargo-check(1) command with\nthe dev profile.test — Builds in the same way as the cargo-test(1) command,\nenabling building in test mode which will enable tests and enable the test\ncfg option. See rustc\ntests for more detail.bench — Builds in the same was as the cargo-bench(1) command,\nsimilar to the test profile.See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--crate-type crate-typeBuild for the given crate type. This flag accepts a comma-separated list of\n1 or more crate types, of which the allowed values are the same as crate-type\nfield in the manifest for configuring a Cargo target. See\ncrate-type field\nfor possible values.
If the manifest contains a list, and --crate-type is provided,\nthe command-line argument value will override what is in the manifest.
This flag only works when building a lib or example library target.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo rustc -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo rustc -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n--openOpen the docs in a browser after building them. This will use your default\nbrowser unless you define another one in the BROWSER environment variable\nor use the doc.browser configuration\noption.
-p spec--package specThe package to document. See cargo-pkgid(1) for the SPEC\nformat.
\n--libDocument the package’s library.
\n--bin name…Document the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsDocument all binary targets.
\n--example name…Document the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesDocument all example targets.
\n--test name…Document the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsDocument all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Document the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesDocument all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsDocument all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleDocument for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseDocument optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameDocument with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo rustdoc -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo rustdoc -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--output-formatThe output type for the documentation emitted. Valid values:
\nhtml (default): Emit the documentation in HTML format.json: Emit the documentation in the experimental JSON format.This option is only available on the nightly channel\nand requires the -Z unstable-options flag to enable.
--limit limitLimit the number of results (default: 10, max: 100).
\n--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-runCompile, but don’t run tests.
\n--no-fail-fastRun all tests regardless of failure. Without this flag, Cargo will exit\nafter the first executable fails. The Rust test harness will run all tests\nwithin the executable to completion, this flag only applies to the executable\nas a whole.
\n-p spec…--package spec…Test only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceTest all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libTest the package’s library.
\n--bin name…Test the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsTest all binary targets.
\n--example name…Test the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesTest all example targets.
\n--test name…Test the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsTest all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Test the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesTest all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsTest all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
--docTest only the library’s documentation. This cannot be mixed with other\ntarget options.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleTest for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseTest optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameTest with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-i spec--invert specShow the reverse dependencies for the given package. This flag will invert\nthe tree and display the packages that depend on the given package.
\nNote that in a workspace, by default it will only display the package’s\nreverse dependencies inside the tree of the workspace member in the current\ndirectory. The --workspace flag can be used to extend it so that it will\nshow the package’s reverse dependencies across the entire workspace. The -p\nflag can be used to display the package’s reverse dependencies only with the\nsubtree of the package given to -p.
--prune specPrune the given package from the display of the dependency tree.
\n--depth depthMaximum display depth of the dependency tree. A depth of 1 displays the direct\ndependencies, for example.
\nIf the given value is workspace, only shows the dependencies that are member\nof the current workspace, instead.
--no-dedupeDo not de-duplicate repeated dependencies. Usually, when a package has already\ndisplayed its dependencies, further occurrences will not re-display its\ndependencies, and will include a (*) to indicate it has already been shown.\nThis flag will cause those duplicates to be repeated.
-d--duplicatesShow only dependencies which come in multiple versions (implies --invert).\nWhen used with the -p flag, only shows duplicates within the subtree of the\ngiven package.
It can be beneficial for build times and executable sizes to avoid building\nthat same package multiple times. This flag can help identify the offending\npackages. You can then investigate if the package that depends on the\nduplicate with the older version can be updated to the newer version so that\nonly one instance is built.
\n-e kinds--edges kindsThe dependency kinds to display. Takes a comma separated list of values:
\nall — Show all edge kinds.normal — Show normal dependencies.build — Show build dependencies.dev — Show development dependencies.features — Show features enabled by each dependency. If this is the only\nkind given, then it will automatically include the other dependency kinds.no-normal — Do not include normal dependencies.no-build — Do not include build dependencies.no-dev — Do not include development dependencies.no-proc-macro — Do not include procedural macro dependencies.The normal, build, dev, and all dependency kinds cannot be mixed with\nno-normal, no-build, or no-dev dependency kinds.
The default is normal,build,dev.
--target tupleFilter dependencies matching the given target tuple.\nThe default is the host platform. Use the value all to include all targets.
--charset charsetChooses the character set to use for the tree. Valid values are “utf8” or\n“ascii”. When unspecified, cargo will auto-select a value.
\n-f format--format formatSet the format string for each package. The default is “{p}”.
\nThis is an arbitrary string which will be used to display each package. The following\nstrings will be replaced with the corresponding value:
\n{p}, {package} — The package name.{l}, {license} — The package license.{r}, {repository} — The package repository URL.{f}, {features} — Comma-separated list of package features that are enabled.{lib} — The name, as used in a use statement, of the package’s library.--prefix prefixSets how each line is displayed. The prefix value can be one of:
\nindent (default) — Shows each line indented as a tree.depth — Show as a list, with the numeric depth printed before each entry.none — Show as a flat list.-p spec…--package spec…Display only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceDisplay all members in the workspace.
\n--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p--package spec…Package to uninstall.
\n--bin name…Only uninstall the binary name.
\n--root dirDirectory to uninstall packages from.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
Update only the specified packages. This flag may be specified\nmultiple times. See cargo-pkgid(1) for the SPEC format.
\nIf packages are specified with spec, then a conservative update of\nthe lockfile will be performed. This means that only the dependency specified\nby SPEC will be updated. Its transitive dependencies will be updated only if\nSPEC cannot be updated without updating dependencies. All other dependencies\nwill remain locked at their currently recorded versions.
\nIf spec is not specified, all dependencies are updated.
\n--recursiveWhen used with spec, dependencies of spec are forced to update as well.\nCannot be used with --precise.
--precise preciseWhen used with spec, allows you to specify a specific version number to set\nthe package to. If the package comes from a git repository, this can be a git\nrevision (such as a SHA hash or tag).
\nWhile not recommended, you can specify a yanked version of a package.\nWhen possible, try other non-yanked SemVer-compatible versions or seek help\nfrom the maintainers of the package.
\nA compatible pre-release version can also be specified even when the version\nrequirement in Cargo.toml doesn’t contain any pre-release identifier (nightly only).
-w--workspaceAttempt to update only packages defined in the workspace. Other packages\nare updated only if they don’t already exist in the lockfile. This\noption is useful for updating Cargo.lock after you’ve changed version\nnumbers in Cargo.toml.
--dry-runDisplays what would be updated, but doesn’t actually write the lockfile.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-s manifest--sync manifestSpecify an extra Cargo.toml manifest to workspaces which should also be\nvendored and synced to the output. May be specified multiple times.
--no-deleteDon’t delete the “vendor” directory when vendoring, but rather keep all\nexisting contents of the vendor directory
\n--respect-source-configInstead of ignoring [source] configuration by default in .cargo/config.toml,\nread it and use it when downloading crates.
--versioned-dirsNormally versions are only added to disambiguate multiple versions of the\nsame package. This option causes all directories in the “vendor” directory\nto be versioned, which makes it easier to track the history of vendored\npackages over time, and can help with the performance of re-vendoring when\nonly a subset of the packages have changed.
\n--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--vers version--version versionThe version to yank or un-yank.
\n--undoUndo a yank, putting a version back into the index.
\n--token tokenAPI token to use when authenticating. This overrides the token stored in\nthe credentials file (which is created by cargo-login(1)).
\nCargo config environment variables can be\nused to override the tokens stored in the credentials file. The token for\ncrates.io may be specified with the CARGO_REGISTRY_TOKEN environment\nvariable. Tokens for other registries may be specified with environment\nvariables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME is the name\nof the registry in all capital letters.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-V--versionPrint version info and exit. If used with --verbose, prints extra\ninformation.
--listList all installed Cargo subcommands. If used with --verbose, prints extra\ninformation.
--explain codeRun rustc --explain CODE which will print out a detailed explanation of an\nerror message (for example, E0004).
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--git url--branch branchBranch to use when adding from git.
\n--tag tagTag to use when adding from git.
\n--rev shaSpecific commit to use when adding from git.
\n--path pathFilesystem path to local crate to add.
\n--base baseThe path base to use when adding a local crate.
\n\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
--devAdd as a development dependency.
\n--buildAdd as a build dependency.
\n--target targetAdd as a dependency to the given target platform.
\nTo avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.
--dry-runDon’t actually write the manifest
\n--rename nameRename the dependency.
\n--optionalMark the dependency as optional.
\n--no-optionalMark the dependency as required.
\n--publicMark the dependency as public.
\nThe dependency can be referenced in your library’s public API.
\n\n--no-publicMark the dependency as private.
\nWhile you can use the crate in your implementation, it cannot be referenced in your public API.
\n\n--no-default-featuresDisable the default features.
\n--default-featuresRe-enable the default features.
\n-F features--features featuresSpace or comma separated list of features to\nactivate. When adding multiple\ncrates, the features for a specific crate may be enabled with\npackage-name/feature-name syntax. This flag may be specified multiple times,\nwhich enables all specified features.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
-p spec--package specAdd dependencies to only the specified package.
\n--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-runCompile, but don’t run benchmarks.
\n--no-fail-fastRun all benchmarks regardless of failure. Without this flag, Cargo will exit\nafter the first executable fails. The Rust test harness will run all benchmarks\nwithin the executable to completion, this flag only applies to the executable\nas a whole.
\n-p spec…--package spec…Benchmark only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceBenchmark all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libBenchmark the package’s library.
\n--bin name…Benchmark the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBenchmark all binary targets.
\n--example name…Benchmark the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBenchmark all example targets.
\n--test name…Benchmark the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBenchmark all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Benchmark the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBenchmark all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBenchmark all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBenchmark for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--profile nameBenchmark with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
-p spec…--package spec…Build only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceBuild all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libBuild the package’s library.
\n--bin name…Build the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBuild all binary targets.
\n--example name…Build the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBuild all example targets.
\n--test name…Build the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBuild all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Build the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBuild all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBuild all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBuild for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseBuild optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameBuild with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
--artifact-dir directoryCopy final artifacts to this directory.
\nThis option is unstable and available only on the\nnightly channel\nand requires the -Z unstable-options flag to enable.\nSee https://github.com/rust-lang/cargo/issues/6790 for more information.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo build -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo build -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-p spec…--package spec…Check only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceCheck all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libCheck the package’s library.
\n--bin name…Check the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsCheck all binary targets.
\n--example name…Check the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesCheck all example targets.
\n--test name…Check the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsCheck all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Check the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesCheck all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsCheck all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleCheck for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseCheck optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameCheck with the given profile.
\nAs a special case, specifying the test profile will also enable checking in\ntest mode which will enable checking tests and enable the test cfg option.\nSee rustc tests for more\ndetail.
See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo check -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo check -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-p spec…--package spec…Clean only the specified packages. This flag may be specified\nmultiple times. See cargo-pkgid(1) for the SPEC format.
\n--workspaceClean artifacts of the workspace members.
\n--dry-runDisplays a summary of what would be deleted without deleting anything.\nUse with --verbose to display the actual files that would be deleted.
--docThis option will cause cargo clean to remove only the doc directory in\nthe target directory.
--releaseRemove artifacts only in the release directory.
--profile nameRemove artifacts only in the directory with the given profile name.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
--target tupleClean for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--openOpen the docs in a browser after building them. This will use your default\nbrowser unless you define another one in the BROWSER environment variable\nor use the doc.browser configuration\noption.
--no-depsDo not build documentation for dependencies.
\n--document-private-itemsInclude non-public items in the documentation. This will be enabled by default if documenting a binary target.
\n-p spec…--package spec…Document only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceDocument all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libDocument the package’s library.
\n--bin name…Document the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsDocument all binary targets.
\n--example name…Document the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesDocument all example targets.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleDocument for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseDocument optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameDocument with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo doc -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo doc -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--output-formatThe output type for the documentation emitted. Valid values:
\nhtml (default): Emit the documentation in HTML format.json: Emit the documentation in the experimental JSON format.This option is only available on the nightly channel\nand requires the -Z unstable-options flag to enable.
--target tupleFetch for the specified target architecture. Flag may be specified multiple times. The default is all architectures. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--broken-codeFix code even if it already has compiler errors. This is useful if cargo fix\nfails to apply the changes. It will apply the changes and leave the broken\ncode in the working directory for you to inspect and manually fix.
--editionApply changes that will update the code to the next edition. This will not\nupdate the edition in the Cargo.toml manifest, which must be updated\nmanually after cargo fix --edition has finished.
--edition-idiomsApply suggestions that will update code to the preferred style for the current\nedition.
\n--allow-no-vcsFix code even if a VCS was not detected.
\n--allow-dirtyFix code even if the working directory has changes (including staged changes).
\n--allow-stagedFix code even if the working directory has staged changes.
\n-p spec…--package spec…Fix only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceFix all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libFix the package’s library.
\n--bin name…Fix the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsFix all binary targets.
\n--example name…Fix the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesFix all example targets.
\n--test name…Fix the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsFix all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Fix the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesFix all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsFix all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleFix for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseFix optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameFix with the given profile.
\nAs a special case, specifying the test profile will also enable checking in\ntest mode which will enable checking tests and enable the test cfg option.\nSee rustc tests for more\ndetail.
See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo fix -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo fix -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--publish-time yyyy-mm-ddThh:mm:ssZLatest publish time allowed for registry packages (Unstable)
\nThis is a best-effort filter on allowed packages, including:
\n--publish-time--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
Fetch information about the specified package. The spec can be a package ID, see cargo-pkgid(1) for the SPEC\nformat.\nIf the specified package is part of the current workspace, information from the local Cargo.toml file will be displayed.\nIf the Cargo.lock file does not exist, it will be created. If no version is specified, the appropriate version will be\nselected based on the Minimum Supported Rust Version (MSRV).
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--binCreate a package with a binary target (src/main.rs).\nThis is the default behavior.
--libCreate a package with a library target (src/lib.rs).
--edition editionSpecify the Rust edition to use. Default is 2024.\nPossible values: 2015, 2018, 2021, 2024
\n--name nameSet the package name. Defaults to the directory name.
\n--vcs vcsInitialize a new VCS repository for the given version control system (git,\nhg, pijul, or fossil) or do not initialize any version control at all\n(none). If not specified, defaults to git or the configuration value\ncargo-new.vcs, or none if already inside a VCS repository.
--registry registryThis sets the publish field in Cargo.toml to the given registry name\nwhich will restrict publishing only to that registry.
Registry names are defined in Cargo config files.\nIf not specified, the default registry defined by the registry.default\nconfig key is used. If the default registry is not set and --registry is not\nused, the publish field will not be set which means that publishing will not\nbe restricted.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--vers version--version versionSpecify a version to install. This may be a version\nrequirement, like ~1.2, to have Cargo\nselect the newest version from the given requirement. If the version does not\nhave a requirement operator (such as ^ or ~), then it must be in the form\nMAJOR.MINOR.PATCH, and will install exactly that version; it is not\ntreated as a caret requirement like Cargo dependencies are.
--git urlGit URL to install the specified crate from.
\n--branch branchBranch to use when installing from git.
\n--tag tagTag to use when installing from git.
\n--rev shaSpecific commit to use when installing from git.
\n--path pathFilesystem path to local crate to install from.
\n--listList all installed packages and their versions.
\n-n--dry-run(unstable) Perform all checks without installing.
\n-f--forceForce overwriting existing crates or binaries. This can be used if a package\nhas installed a binary with the same name as another package. This is also\nuseful if something has changed on the system that you want to rebuild with,\nsuch as a newer version of rustc.
--no-trackBy default, Cargo keeps track of the installed packages with a metadata file\nstored in the installation root directory. This flag tells Cargo not to use or\ncreate that file. With this flag, Cargo will refuse to overwrite any existing\nfiles unless the --force flag is used. This also disables Cargo’s ability to\nprotect against multiple concurrent invocations of Cargo installing at the\nsame time.
--bin name…Install only the specified binary.
\n--binsInstall all binaries. This is the default behavior.
\n--example name…Install only the specified example.
\n--examplesInstall all examples.
\n--root dirDirectory to install packages into.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
--index indexThe URL of the registry index to use.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleInstall for the specified target architecture. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to a new temporary folder located in the\ntemporary directory of the platform.
When using --path, by default it will use target directory in the workspace\nof the local crate unless --target-dir\nis specified.
--debugBuild with the debug profile instead of the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameInstall with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo install -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo install -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--workspaceLocate the Cargo.toml at the root of the workspace, as opposed to the current\nworkspace member.
--message-format fmtThe representation in which to print the project location. Valid values:
\njson (default): JSON object with the path under the key “root”.plain: Just the path.-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-depsOutput information only about the workspace members and don’t fetch\ndependencies.
\n--format-version versionSpecify the version of the output format to use. Currently 1 is the only\npossible value.
--filter-platform tupleThis filters the resolve output to only include dependencies for the\ngiven target tuple.\nA literal \"host-tuple\" can be used, which will internally be substituted by the host’s target.\nWithout this flag, the resolve includes all targets.
Note that the dependencies listed in the “packages” array still includes all\ndependencies. Each package definition is intended to be an unaltered\nreproduction of the information within Cargo.toml.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--binCreate a package with a binary target (src/main.rs).\nThis is the default behavior.
--libCreate a package with a library target (src/lib.rs).
--edition editionSpecify the Rust edition to use. Default is 2024.\nPossible values: 2015, 2018, 2021, 2024
\n--name nameSet the package name. Defaults to the directory name.
\n--vcs vcsInitialize a new VCS repository for the given version control system (git,\nhg, pijul, or fossil) or do not initialize any version control at all\n(none). If not specified, defaults to git or the configuration value\ncargo-new.vcs, or none if already inside a VCS repository.
--registry registryThis sets the publish field in Cargo.toml to the given registry name\nwhich will restrict publishing only to that registry.
Registry names are defined in Cargo config files.\nIf not specified, the default registry defined by the registry.default\nconfig key is used. If the default registry is not set and --registry is not\nused, the publish field will not be set which means that publishing will not\nbe restricted.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-a--add login…Invite the given user or team as an owner.
\n-r--remove login…Remove the given user or team as an owner.
\n-l--listList owners of a crate.
\n--token tokenAPI token to use when authenticating. This overrides the token stored in\nthe credentials file (which is created by cargo-login(1)).
\nCargo config environment variables can be\nused to override the tokens stored in the credentials file. The token for\ncrates.io may be specified with the CARGO_REGISTRY_TOKEN environment\nvariable. Tokens for other registries may be specified with environment\nvariables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME is the name\nof the registry in all capital letters.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-l--listPrint files included in a package without making one.
\n--no-verifyDon’t verify the contents by building them.
\n--no-metadataIgnore warnings about a lack of human-usable metadata (such as the description\nor the license).
\n--allow-dirtyAllow working directories with uncommitted VCS changes to be packaged.
\n--exclude-lockfileDon’t include the lock file when packaging.
\nThis flag is not for general use.\nSome tools may expect a lock file to be present (e.g. cargo install --locked).\nConsider other options before using this.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to package for; see cargo publish --help for more details\nabout configuration of registry names. The packages will not be published\nto this registry, but if we are packaging multiple inter-dependent crates,\nlock-files will be generated under the assumption that dependencies will be\npublished to this registry.
--message-format fmtSpecifies the output message format.\nCurrently, it only works with --list and affects the file listing format.\nThis is unstable and requires -Zunstable-options.\nValid output formats:
human (default): Display in a file-per-line format.json: Emit machine-readable JSON information about each package.\nOne package per JSON line (Newline delimited JSON).\n{\n /* The Package ID Spec of the package. */\n \"id\": \"path+file:///home/foo#0.0.0\",\n /* Files of this package */\n \"files\" {\n /* Relative path in the archive file. */\n \"Cargo.toml.orig\": {\n /* Where the file is from.\n - \"generate\" for file being generated during packaging\n - \"copy\" for file being copied from another location.\n */\n \"kind\": \"copy\",\n /* For the \"copy\" kind,\n it is an absolute path to the actual file content.\n For the \"generate\" kind,\n it is the original file the generated one is based on.\n */\n \"path\": \"/home/foo/Cargo.toml\"\n },\n \"Cargo.toml\": {\n \"kind\": \"generate\",\n \"path\": \"/home/foo/Cargo.toml\"\n },\n \"src/main.rs\": {\n \"kind\": \"copy\",\n \"path\": \"/home/foo/src/main.rs\"\n }\n }\n}\n-p spec…--package spec…Package only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspacePackage all members in the workspace.
\n--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--target tuplePackage for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo package -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo package -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p spec--package specGet the package ID for the given package instead of the current package.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--dry-runPerform all checks without uploading.
\n--no-verifyDon’t verify the contents by building them.
\n--allow-dirtyAllow working directories with uncommitted VCS changes to be packaged.
\n--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to publish to. Registry names are defined in Cargo\nconfig files. If not specified, and there is a\npackage.publish field in\nCargo.toml with a single registry, then it will publish to that registry.\nOtherwise it will use the default registry, which is defined by the\nregistry.default config key\nwhich defaults to crates-io.
-p spec…--package spec…Publish only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspacePublish all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--target tuplePublish for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo publish -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo publish -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--devRemove as a development dependency.
\n--buildRemove as a build dependency.
\n--target targetRemove as a dependency to the given target platform.
\nTo avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.
--dry-runDon’t actually write to the manifest.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-p spec…--package spec…Package to remove from.
\n+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--id idShow the report with the specified Cargo-generated id.\nIf not specified, shows the most recent report.
\n-p spec--package specThe package to display a report for. See cargo-pkgid(1) for the SPEC\nformat.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p spec--package specThe package to run. See cargo-pkgid(1) for the SPEC\nformat.
\n--bin nameRun the specified binary.
\n--example nameRun the specified example.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleRun for the specified target architecture. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseRun optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameRun with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo run -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo run -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-p spec--package specThe package to build. See cargo-pkgid(1) for the SPEC\nformat.
\n--libBuild the package’s library.
\n--bin name…Build the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBuild all binary targets.
\n--example name…Build the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBuild all example targets.
\n--test name…Build the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBuild all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Build the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBuild all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBuild all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBuild for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseBuild optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameBuild with the given profile.
\nThe rustc subcommand will treat the following named profiles with special behaviors:
check — Builds in the same way as the cargo-check(1) command with\nthe dev profile.test — Builds in the same way as the cargo-test(1) command,\nenabling building in test mode which will enable tests and enable the test\ncfg option. See rustc\ntests for more detail.bench — Builds in the same was as the cargo-bench(1) command,\nsimilar to the test profile.See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--crate-type crate-typeBuild for the given crate type. This flag accepts a comma-separated list of\n1 or more crate types, of which the allowed values are the same as crate-type\nfield in the manifest for configuring a Cargo target. See\ncrate-type field\nfor possible values.
If the manifest contains a list, and --crate-type is provided,\nthe command-line argument value will override what is in the manifest.
This flag only works when building a lib or example library target.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo rustc -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo rustc -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n--openOpen the docs in a browser after building them. This will use your default\nbrowser unless you define another one in the BROWSER environment variable\nor use the doc.browser configuration\noption.
-p spec--package specThe package to document. See cargo-pkgid(1) for the SPEC\nformat.
\n--libDocument the package’s library.
\n--bin name…Document the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsDocument all binary targets.
\n--example name…Document the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesDocument all example targets.
\n--test name…Document the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsDocument all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Document the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesDocument all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsDocument all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleDocument for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseDocument optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameDocument with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo rustdoc -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo rustdoc -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--output-formatThe output type for the documentation emitted. Valid values:
\nhtml (default): Emit the documentation in HTML format.json: Emit the documentation in the experimental JSON format.This option is only available on the nightly channel\nand requires the -Z unstable-options flag to enable.
--limit limitLimit the number of results (default: 10, max: 100).
\n--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-runCompile, but don’t run tests.
\n--no-fail-fastRun all tests regardless of failure. Without this flag, Cargo will exit\nafter the first executable fails. The Rust test harness will run all tests\nwithin the executable to completion, this flag only applies to the executable\nas a whole.
\n-p spec…--package spec…Test only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceTest all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libTest the package’s library.
\n--bin name…Test the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsTest all binary targets.
\n--example name…Test the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesTest all example targets.
\n--test name…Test the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsTest all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Test the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesTest all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsTest all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
--docTest only the library’s documentation. This cannot be mixed with other\ntarget options.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleTest for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseTest optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameTest with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-i spec--invert specShow the reverse dependencies for the given package. This flag will invert\nthe tree and display the packages that depend on the given package.
\nNote that in a workspace, by default it will only display the package’s\nreverse dependencies inside the tree of the workspace member in the current\ndirectory. The --workspace flag can be used to extend it so that it will\nshow the package’s reverse dependencies across the entire workspace. The -p\nflag can be used to display the package’s reverse dependencies only with the\nsubtree of the package given to -p.
--prune specPrune the given package from the display of the dependency tree.
\n--depth depthMaximum display depth of the dependency tree. A depth of 1 displays the direct\ndependencies, for example.
\nIf the given value is workspace, only shows the dependencies that are member\nof the current workspace, instead.
--no-dedupeDo not de-duplicate repeated dependencies. Usually, when a package has already\ndisplayed its dependencies, further occurrences will not re-display its\ndependencies, and will include a (*) to indicate it has already been shown.\nThis flag will cause those duplicates to be repeated.
-d--duplicatesShow only dependencies which come in multiple versions (implies --invert).\nWhen used with the -p flag, only shows duplicates within the subtree of the\ngiven package.
It can be beneficial for build times and executable sizes to avoid building\nthat same package multiple times. This flag can help identify the offending\npackages. You can then investigate if the package that depends on the\nduplicate with the older version can be updated to the newer version so that\nonly one instance is built.
\n-e kinds--edges kindsThe dependency kinds to display. Takes a comma separated list of values:
\nall — Show all edge kinds.normal — Show normal dependencies.build — Show build dependencies.dev — Show development dependencies.features — Show features enabled by each dependency. If this is the only\nkind given, then it will automatically include the other dependency kinds.no-normal — Do not include normal dependencies.no-build — Do not include build dependencies.no-dev — Do not include development dependencies.no-proc-macro — Do not include procedural macro dependencies.The normal, build, dev, and all dependency kinds cannot be mixed with\nno-normal, no-build, or no-dev dependency kinds.
The default is normal,build,dev.
--target tupleFilter dependencies matching the given target tuple.\nThe default is the host platform. Use the value all to include all targets.
--charset charsetChooses the character set to use for the tree. Valid values are “utf8” or\n“ascii”. When unspecified, cargo will auto-select a value.
\n-f format--format formatSet the format string for each package. The default is “{p}”.
\nThis is an arbitrary string which will be used to display each package. The following\nstrings will be replaced with the corresponding value:
\n{p}, {package} — The package name.{l}, {license} — The package license.{r}, {repository} — The package repository URL.{f}, {features} — Comma-separated list of package features that are enabled.{lib} — The name, as used in a use statement, of the package’s library.--prefix prefixSets how each line is displayed. The prefix value can be one of:
\nindent (default) — Shows each line indented as a tree.depth — Show as a list, with the numeric depth printed before each entry.none — Show as a flat list.-p spec…--package spec…Display only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceDisplay all members in the workspace.
\n--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p--package spec…Package to uninstall.
\n--bin name…Only uninstall the binary name.
\n--root dirDirectory to uninstall packages from.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
Update only the specified packages. This flag may be specified\nmultiple times. See cargo-pkgid(1) for the SPEC format.
\nIf packages are specified with spec, then a conservative update of\nthe lockfile will be performed. This means that only the dependency specified\nby SPEC will be updated. Its transitive dependencies will be updated only if\nSPEC cannot be updated without updating dependencies. All other dependencies\nwill remain locked at their currently recorded versions.
\nIf spec is not specified, all dependencies are updated.
\n--recursiveWhen used with spec, dependencies of spec are forced to update as well.\nCannot be used with --precise.
--precise preciseWhen used with spec, allows you to specify a specific version number to set\nthe package to. If the package comes from a git repository, this can be a git\nrevision (such as a SHA hash or tag).
\nWhile not recommended, you can specify a yanked version of a package.\nWhen possible, try other non-yanked SemVer-compatible versions or seek help\nfrom the maintainers of the package.
\nA compatible pre-release version can also be specified even when the version\nrequirement in Cargo.toml doesn’t contain any pre-release identifier (nightly only).
-w--workspaceAttempt to update only packages defined in the workspace. Other packages\nare updated only if they don’t already exist in the lockfile. This\noption is useful for updating Cargo.lock after you’ve changed version\nnumbers in Cargo.toml.
--dry-runDisplays what would be updated, but doesn’t actually write the lockfile.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-s manifest--sync manifestSpecify an extra Cargo.toml manifest to workspaces which should also be\nvendored and synced to the output. May be specified multiple times.
--no-deleteDon’t delete the “vendor” directory when vendoring, but rather keep all\nexisting contents of the vendor directory
\n--respect-source-configInstead of ignoring [source] configuration by default in .cargo/config.toml,\nread it and use it when downloading crates.
--versioned-dirsNormally versions are only added to disambiguate multiple versions of the\nsame package. This option causes all directories in the “vendor” directory\nto be versioned, which makes it easier to track the history of vendored\npackages over time, and can help with the performance of re-vendoring when\nonly a subset of the packages have changed.
\n--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--vers version--version versionThe version to yank or un-yank.
\n--undoUndo a yank, putting a version back into the index.
\n--token tokenAPI token to use when authenticating. This overrides the token stored in\nthe credentials file (which is created by cargo-login(1)).
\nCargo config environment variables can be\nused to override the tokens stored in the credentials file. The token for\ncrates.io may be specified with the CARGO_REGISTRY_TOKEN environment\nvariable. Tokens for other registries may be specified with environment\nvariables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME is the name\nof the registry in all capital letters.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-V--versionPrint version info and exit. If used with --verbose, prints extra\ninformation.
--listList all installed Cargo subcommands. If used with --verbose, prints extra\ninformation.
--explain codeRun rustc --explain CODE which will print out a detailed explanation of an\nerror message (for example, E0004).
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--git url--branch branchBranch to use when adding from git.
\n--tag tagTag to use when adding from git.
\n--rev shaSpecific commit to use when adding from git.
\n--path pathFilesystem path to local crate to add.
\n--base baseThe path base to use when adding a local crate.
\n\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
--devAdd as a development dependency.
\n--buildAdd as a build dependency.
\n--target targetAdd as a dependency to the given target platform.
\nTo avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.
--dry-runDon’t actually write the manifest
\n--rename nameRename the dependency.
\n--optionalMark the dependency as optional.
\n--no-optionalMark the dependency as required.
\n--publicMark the dependency as public.
\nThe dependency can be referenced in your library’s public API.
\n\n--no-publicMark the dependency as private.
\nWhile you can use the crate in your implementation, it cannot be referenced in your public API.
\n\n--no-default-featuresDisable the default features.
\n--default-featuresRe-enable the default features.
\n-F features--features featuresSpace or comma separated list of features to\nactivate. When adding multiple\ncrates, the features for a specific crate may be enabled with\npackage-name/feature-name syntax. This flag may be specified multiple times,\nwhich enables all specified features.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
-p spec--package specAdd dependencies to only the specified package.
\n--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-runCompile, but don’t run benchmarks.
\n--no-fail-fastRun all benchmarks regardless of failure. Without this flag, Cargo will exit\nafter the first executable fails. The Rust test harness will run all benchmarks\nwithin the executable to completion, this flag only applies to the executable\nas a whole.
\n-p spec…--package spec…Benchmark only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceBenchmark all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libBenchmark the package’s library.
\n--bin name…Benchmark the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBenchmark all binary targets.
\n--example name…Benchmark the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBenchmark all example targets.
\n--test name…Benchmark the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBenchmark all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Benchmark the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBenchmark all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBenchmark all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBenchmark for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--profile nameBenchmark with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
-p spec…--package spec…Build only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceBuild all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libBuild the package’s library.
\n--bin name…Build the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBuild all binary targets.
\n--example name…Build the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBuild all example targets.
\n--test name…Build the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBuild all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Build the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBuild all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBuild all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBuild for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseBuild optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameBuild with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
--artifact-dir directoryCopy final artifacts to this directory.
\nThis option is unstable and available only on the\nnightly channel\nand requires the -Z unstable-options flag to enable.\nSee https://github.com/rust-lang/cargo/issues/6790 for more information.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo build -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo build -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-p spec…--package spec…Check only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceCheck all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libCheck the package’s library.
\n--bin name…Check the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsCheck all binary targets.
\n--example name…Check the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesCheck all example targets.
\n--test name…Check the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsCheck all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Check the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesCheck all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsCheck all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleCheck for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseCheck optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameCheck with the given profile.
\nAs a special case, specifying the test profile will also enable checking in\ntest mode which will enable checking tests and enable the test cfg option.\nSee rustc tests for more\ndetail.
See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo check -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo check -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-p spec…--package spec…Clean only the specified packages. This flag may be specified\nmultiple times. See cargo-pkgid(1) for the SPEC format.
\n--workspaceClean artifacts of the workspace members.
\n--dry-runDisplays a summary of what would be deleted without deleting anything.\nUse with --verbose to display the actual files that would be deleted.
--docThis option will cause cargo clean to remove only the doc directory in\nthe target directory.
--releaseRemove artifacts only in the release directory.
--profile nameRemove artifacts only in the directory with the given profile name.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
--target tupleClean for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--openOpen the docs in a browser after building them. This will use your default\nbrowser unless you define another one in the BROWSER environment variable\nor use the doc.browser configuration\noption.
--no-depsDo not build documentation for dependencies.
\n--document-private-itemsInclude non-public items in the documentation. This will be enabled by default if documenting a binary target.
\n-p spec…--package spec…Document only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceDocument all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libDocument the package’s library.
\n--bin name…Document the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsDocument all binary targets.
\n--example name…Document the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesDocument all example targets.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleDocument for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseDocument optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameDocument with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo doc -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo doc -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--output-formatThe output type for the documentation emitted. Valid values:
\nhtml (default): Emit the documentation in HTML format.json: Emit the documentation in the experimental JSON format.This option is only available on the nightly channel\nand requires the -Z unstable-options flag to enable.
--target tupleFetch for the specified target architecture. Flag may be specified multiple times. The default is all architectures. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--broken-codeFix code even if it already has compiler errors. This is useful if cargo fix\nfails to apply the changes. It will apply the changes and leave the broken\ncode in the working directory for you to inspect and manually fix.
--editionApply changes that will update the code to the next edition. This will not\nupdate the edition in the Cargo.toml manifest, which must be updated\nmanually after cargo fix --edition has finished.
--edition-idiomsApply suggestions that will update code to the preferred style for the current\nedition.
\n--allow-no-vcsFix code even if a VCS was not detected.
\n--allow-dirtyFix code even if the working directory has changes (including staged changes).
\n--allow-stagedFix code even if the working directory has staged changes.
\n-p spec…--package spec…Fix only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceFix all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libFix the package’s library.
\n--bin name…Fix the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsFix all binary targets.
\n--example name…Fix the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesFix all example targets.
\n--test name…Fix the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsFix all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Fix the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesFix all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsFix all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleFix for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseFix optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameFix with the given profile.
\nAs a special case, specifying the test profile will also enable checking in\ntest mode which will enable checking tests and enable the test cfg option.\nSee rustc tests for more\ndetail.
See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo fix -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo fix -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--publish-time yyyy-mm-ddThh:mm:ssZLatest publish time allowed for registry packages (Unstable)
\nThis is a best-effort filter on allowed packages, including:
\n--publish-time--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
Fetch information about the specified package. The spec can be a package ID, see cargo-pkgid(1) for the SPEC\nformat.\nIf the specified package is part of the current workspace, information from the local Cargo.toml file will be displayed.\nIf the Cargo.lock file does not exist, it will be created. If no version is specified, the appropriate version will be\nselected based on the Minimum Supported Rust Version (MSRV).
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--binCreate a package with a binary target (src/main.rs).\nThis is the default behavior.
--libCreate a package with a library target (src/lib.rs).
--edition editionSpecify the Rust edition to use. Default is 2024.\nPossible values: 2015, 2018, 2021, 2024
\n--name nameSet the package name. Defaults to the directory name.
\n--vcs vcsInitialize a new VCS repository for the given version control system (git,\nhg, pijul, or fossil) or do not initialize any version control at all\n(none). If not specified, defaults to git or the configuration value\ncargo-new.vcs, or none if already inside a VCS repository.
--registry registryThis sets the publish field in Cargo.toml to the given registry name\nwhich will restrict publishing only to that registry.
Registry names are defined in Cargo config files.\nIf not specified, the default registry defined by the registry.default\nconfig key is used. If the default registry is not set and --registry is not\nused, the publish field will not be set which means that publishing will not\nbe restricted.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--vers version--version versionSpecify a version to install. This may be a version\nrequirement, like ~1.2, to have Cargo\nselect the newest version from the given requirement. If the version does not\nhave a requirement operator (such as ^ or ~), then it must be in the form\nMAJOR.MINOR.PATCH, and will install exactly that version; it is not\ntreated as a caret requirement like Cargo dependencies are.
--git urlGit URL to install the specified crate from.
\n--branch branchBranch to use when installing from git.
\n--tag tagTag to use when installing from git.
\n--rev shaSpecific commit to use when installing from git.
\n--path pathFilesystem path to local crate to install from.
\n--listList all installed packages and their versions.
\n-n--dry-run(unstable) Perform all checks without installing.
\n-f--forceForce overwriting existing crates or binaries. This can be used if a package\nhas installed a binary with the same name as another package. This is also\nuseful if something has changed on the system that you want to rebuild with,\nsuch as a newer version of rustc.
--no-trackBy default, Cargo keeps track of the installed packages with a metadata file\nstored in the installation root directory. This flag tells Cargo not to use or\ncreate that file. With this flag, Cargo will refuse to overwrite any existing\nfiles unless the --force flag is used. This also disables Cargo’s ability to\nprotect against multiple concurrent invocations of Cargo installing at the\nsame time.
--bin name…Install only the specified binary.
\n--binsInstall all binaries. This is the default behavior.
\n--example name…Install only the specified example.
\n--examplesInstall all examples.
\n--root dirDirectory to install packages into.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
--index indexThe URL of the registry index to use.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleInstall for the specified target architecture. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to a new temporary folder located in the\ntemporary directory of the platform.
When using --path, by default it will use target directory in the workspace\nof the local crate unless --target-dir\nis specified.
--debugBuild with the debug profile instead of the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameInstall with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo install -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo install -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--workspaceLocate the Cargo.toml at the root of the workspace, as opposed to the current\nworkspace member.
--message-format fmtThe representation in which to print the project location. Valid values:
\njson (default): JSON object with the path under the key “root”.plain: Just the path.-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-depsOutput information only about the workspace members and don’t fetch\ndependencies.
\n--format-version versionSpecify the version of the output format to use. Currently 1 is the only\npossible value.
--filter-platform tupleThis filters the resolve output to only include dependencies for the\ngiven target tuple.\nA literal \"host-tuple\" can be used, which will internally be substituted by the host’s target.\nWithout this flag, the resolve includes all targets.
Note that the dependencies listed in the “packages” array still includes all\ndependencies. Each package definition is intended to be an unaltered\nreproduction of the information within Cargo.toml.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--binCreate a package with a binary target (src/main.rs).\nThis is the default behavior.
--libCreate a package with a library target (src/lib.rs).
--edition editionSpecify the Rust edition to use. Default is 2024.\nPossible values: 2015, 2018, 2021, 2024
\n--name nameSet the package name. Defaults to the directory name.
\n--vcs vcsInitialize a new VCS repository for the given version control system (git,\nhg, pijul, or fossil) or do not initialize any version control at all\n(none). If not specified, defaults to git or the configuration value\ncargo-new.vcs, or none if already inside a VCS repository.
--registry registryThis sets the publish field in Cargo.toml to the given registry name\nwhich will restrict publishing only to that registry.
Registry names are defined in Cargo config files.\nIf not specified, the default registry defined by the registry.default\nconfig key is used. If the default registry is not set and --registry is not\nused, the publish field will not be set which means that publishing will not\nbe restricted.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-a--add login…Invite the given user or team as an owner.
\n-r--remove login…Remove the given user or team as an owner.
\n-l--listList owners of a crate.
\n--token tokenAPI token to use when authenticating. This overrides the token stored in\nthe credentials file (which is created by cargo-login(1)).
\nCargo config environment variables can be\nused to override the tokens stored in the credentials file. The token for\ncrates.io may be specified with the CARGO_REGISTRY_TOKEN environment\nvariable. Tokens for other registries may be specified with environment\nvariables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME is the name\nof the registry in all capital letters.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-l--listPrint files included in a package without making one.
\n--no-verifyDon’t verify the contents by building them.
\n--no-metadataIgnore warnings about a lack of human-usable metadata (such as the description\nor the license).
\n--allow-dirtyAllow working directories with uncommitted VCS changes to be packaged.
\n--exclude-lockfileDon’t include the lock file when packaging.
\nThis flag is not for general use.\nSome tools may expect a lock file to be present (e.g. cargo install --locked).\nConsider other options before using this.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to package for; see cargo publish --help for more details\nabout configuration of registry names. The packages will not be published\nto this registry, but if we are packaging multiple inter-dependent crates,\nlock-files will be generated under the assumption that dependencies will be\npublished to this registry.
--message-format fmtSpecifies the output message format.\nCurrently, it only works with --list and affects the file listing format.\nThis is unstable and requires -Zunstable-options.\nValid output formats:
human (default): Display in a file-per-line format.json: Emit machine-readable JSON information about each package.\nOne package per JSON line (Newline delimited JSON).\n{\n /* The Package ID Spec of the package. */\n \"id\": \"path+file:///home/foo#0.0.0\",\n /* Files of this package */\n \"files\" {\n /* Relative path in the archive file. */\n \"Cargo.toml.orig\": {\n /* Where the file is from.\n - \"generate\" for file being generated during packaging\n - \"copy\" for file being copied from another location.\n */\n \"kind\": \"copy\",\n /* For the \"copy\" kind,\n it is an absolute path to the actual file content.\n For the \"generate\" kind,\n it is the original file the generated one is based on.\n */\n \"path\": \"/home/foo/Cargo.toml\"\n },\n \"Cargo.toml\": {\n \"kind\": \"generate\",\n \"path\": \"/home/foo/Cargo.toml\"\n },\n \"src/main.rs\": {\n \"kind\": \"copy\",\n \"path\": \"/home/foo/src/main.rs\"\n }\n }\n}\n-p spec…--package spec…Package only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspacePackage all members in the workspace.
\n--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--target tuplePackage for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo package -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo package -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p spec--package specGet the package ID for the given package instead of the current package.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--dry-runPerform all checks without uploading.
\n--no-verifyDon’t verify the contents by building them.
\n--allow-dirtyAllow working directories with uncommitted VCS changes to be packaged.
\n--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to publish to. Registry names are defined in Cargo\nconfig files. If not specified, and there is a\npackage.publish field in\nCargo.toml with a single registry, then it will publish to that registry.\nOtherwise it will use the default registry, which is defined by the\nregistry.default config key\nwhich defaults to crates-io.
-p spec…--package spec…Publish only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspacePublish all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--target tuplePublish for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo publish -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo publish -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--devRemove as a development dependency.
\n--buildRemove as a build dependency.
\n--target targetRemove as a dependency to the given target platform.
\nTo avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.
--dry-runDon’t actually write to the manifest.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-p spec…--package spec…Package to remove from.
\n+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--id idShow the report with the specified Cargo-generated id.\nIf not specified, shows the most recent report.
\n-p spec--package specThe package to display a report for. See cargo-pkgid(1) for the SPEC\nformat.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p spec--package specThe package to run. See cargo-pkgid(1) for the SPEC\nformat.
\n--bin nameRun the specified binary.
\n--example nameRun the specified example.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleRun for the specified target architecture. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseRun optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameRun with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo run -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo run -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-p spec--package specThe package to build. See cargo-pkgid(1) for the SPEC\nformat.
\n--libBuild the package’s library.
\n--bin name…Build the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBuild all binary targets.
\n--example name…Build the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBuild all example targets.
\n--test name…Build the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBuild all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Build the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBuild all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBuild all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBuild for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseBuild optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameBuild with the given profile.
\nThe rustc subcommand will treat the following named profiles with special behaviors:
check — Builds in the same way as the cargo-check(1) command with\nthe dev profile.test — Builds in the same way as the cargo-test(1) command,\nenabling building in test mode which will enable tests and enable the test\ncfg option. See rustc\ntests for more detail.bench — Builds in the same was as the cargo-bench(1) command,\nsimilar to the test profile.See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--crate-type crate-typeBuild for the given crate type. This flag accepts a comma-separated list of\n1 or more crate types, of which the allowed values are the same as crate-type\nfield in the manifest for configuring a Cargo target. See\ncrate-type field\nfor possible values.
If the manifest contains a list, and --crate-type is provided,\nthe command-line argument value will override what is in the manifest.
This flag only works when building a lib or example library target.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo rustc -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo rustc -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n--openOpen the docs in a browser after building them. This will use your default\nbrowser unless you define another one in the BROWSER environment variable\nor use the doc.browser configuration\noption.
-p spec--package specThe package to document. See cargo-pkgid(1) for the SPEC\nformat.
\n--libDocument the package’s library.
\n--bin name…Document the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsDocument all binary targets.
\n--example name…Document the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesDocument all example targets.
\n--test name…Document the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsDocument all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Document the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesDocument all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsDocument all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleDocument for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseDocument optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameDocument with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo rustdoc -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo rustdoc -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--output-formatThe output type for the documentation emitted. Valid values:
\nhtml (default): Emit the documentation in HTML format.json: Emit the documentation in the experimental JSON format.This option is only available on the nightly channel\nand requires the -Z unstable-options flag to enable.
--limit limitLimit the number of results (default: 10, max: 100).
\n--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-runCompile, but don’t run tests.
\n--no-fail-fastRun all tests regardless of failure. Without this flag, Cargo will exit\nafter the first executable fails. The Rust test harness will run all tests\nwithin the executable to completion, this flag only applies to the executable\nas a whole.
\n-p spec…--package spec…Test only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceTest all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libTest the package’s library.
\n--bin name…Test the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsTest all binary targets.
\n--example name…Test the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesTest all example targets.
\n--test name…Test the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsTest all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Test the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesTest all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsTest all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
--docTest only the library’s documentation. This cannot be mixed with other\ntarget options.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleTest for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseTest optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameTest with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-i spec--invert specShow the reverse dependencies for the given package. This flag will invert\nthe tree and display the packages that depend on the given package.
\nNote that in a workspace, by default it will only display the package’s\nreverse dependencies inside the tree of the workspace member in the current\ndirectory. The --workspace flag can be used to extend it so that it will\nshow the package’s reverse dependencies across the entire workspace. The -p\nflag can be used to display the package’s reverse dependencies only with the\nsubtree of the package given to -p.
--prune specPrune the given package from the display of the dependency tree.
\n--depth depthMaximum display depth of the dependency tree. A depth of 1 displays the direct\ndependencies, for example.
\nIf the given value is workspace, only shows the dependencies that are member\nof the current workspace, instead.
--no-dedupeDo not de-duplicate repeated dependencies. Usually, when a package has already\ndisplayed its dependencies, further occurrences will not re-display its\ndependencies, and will include a (*) to indicate it has already been shown.\nThis flag will cause those duplicates to be repeated.
-d--duplicatesShow only dependencies which come in multiple versions (implies --invert).\nWhen used with the -p flag, only shows duplicates within the subtree of the\ngiven package.
It can be beneficial for build times and executable sizes to avoid building\nthat same package multiple times. This flag can help identify the offending\npackages. You can then investigate if the package that depends on the\nduplicate with the older version can be updated to the newer version so that\nonly one instance is built.
\n-e kinds--edges kindsThe dependency kinds to display. Takes a comma separated list of values:
\nall — Show all edge kinds.normal — Show normal dependencies.build — Show build dependencies.dev — Show development dependencies.features — Show features enabled by each dependency. If this is the only\nkind given, then it will automatically include the other dependency kinds.no-normal — Do not include normal dependencies.no-build — Do not include build dependencies.no-dev — Do not include development dependencies.no-proc-macro — Do not include procedural macro dependencies.The normal, build, dev, and all dependency kinds cannot be mixed with\nno-normal, no-build, or no-dev dependency kinds.
The default is normal,build,dev.
--target tupleFilter dependencies matching the given target tuple.\nThe default is the host platform. Use the value all to include all targets.
--charset charsetChooses the character set to use for the tree. Valid values are “utf8” or\n“ascii”. When unspecified, cargo will auto-select a value.
\n-f format--format formatSet the format string for each package. The default is “{p}”.
\nThis is an arbitrary string which will be used to display each package. The following\nstrings will be replaced with the corresponding value:
\n{p}, {package} — The package name.{l}, {license} — The package license.{r}, {repository} — The package repository URL.{f}, {features} — Comma-separated list of package features that are enabled.{lib} — The name, as used in a use statement, of the package’s library.--prefix prefixSets how each line is displayed. The prefix value can be one of:
\nindent (default) — Shows each line indented as a tree.depth — Show as a list, with the numeric depth printed before each entry.none — Show as a flat list.-p spec…--package spec…Display only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceDisplay all members in the workspace.
\n--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p--package spec…Package to uninstall.
\n--bin name…Only uninstall the binary name.
\n--root dirDirectory to uninstall packages from.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
Update only the specified packages. This flag may be specified\nmultiple times. See cargo-pkgid(1) for the SPEC format.
\nIf packages are specified with spec, then a conservative update of\nthe lockfile will be performed. This means that only the dependency specified\nby SPEC will be updated. Its transitive dependencies will be updated only if\nSPEC cannot be updated without updating dependencies. All other dependencies\nwill remain locked at their currently recorded versions.
\nIf spec is not specified, all dependencies are updated.
\n--recursiveWhen used with spec, dependencies of spec are forced to update as well.\nCannot be used with --precise.
--precise preciseWhen used with spec, allows you to specify a specific version number to set\nthe package to. If the package comes from a git repository, this can be a git\nrevision (such as a SHA hash or tag).
\nWhile not recommended, you can specify a yanked version of a package.\nWhen possible, try other non-yanked SemVer-compatible versions or seek help\nfrom the maintainers of the package.
\nA compatible pre-release version can also be specified even when the version\nrequirement in Cargo.toml doesn’t contain any pre-release identifier (nightly only).
-w--workspaceAttempt to update only packages defined in the workspace. Other packages\nare updated only if they don’t already exist in the lockfile. This\noption is useful for updating Cargo.lock after you’ve changed version\nnumbers in Cargo.toml.
--dry-runDisplays what would be updated, but doesn’t actually write the lockfile.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-s manifest--sync manifestSpecify an extra Cargo.toml manifest to workspaces which should also be\nvendored and synced to the output. May be specified multiple times.
--no-deleteDon’t delete the “vendor” directory when vendoring, but rather keep all\nexisting contents of the vendor directory
\n--respect-source-configInstead of ignoring [source] configuration by default in .cargo/config.toml,\nread it and use it when downloading crates.
--versioned-dirsNormally versions are only added to disambiguate multiple versions of the\nsame package. This option causes all directories in the “vendor” directory\nto be versioned, which makes it easier to track the history of vendored\npackages over time, and can help with the performance of re-vendoring when\nonly a subset of the packages have changed.
\n--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--vers version--version versionThe version to yank or un-yank.
\n--undoUndo a yank, putting a version back into the index.
\n--token tokenAPI token to use when authenticating. This overrides the token stored in\nthe credentials file (which is created by cargo-login(1)).
\nCargo config environment variables can be\nused to override the tokens stored in the credentials file. The token for\ncrates.io may be specified with the CARGO_REGISTRY_TOKEN environment\nvariable. Tokens for other registries may be specified with environment\nvariables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME is the name\nof the registry in all capital letters.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-V--versionPrint version info and exit. If used with --verbose, prints extra\ninformation.
--listList all installed Cargo subcommands. If used with --verbose, prints extra\ninformation.
--explain codeRun rustc --explain CODE which will print out a detailed explanation of an\nerror message (for example, E0004).
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--git url--branch branchBranch to use when adding from git.
\n--tag tagTag to use when adding from git.
\n--rev shaSpecific commit to use when adding from git.
\n--path pathFilesystem path to local crate to add.
\n--base baseThe path base to use when adding a local crate.
\n\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
--devAdd as a development dependency.
\n--buildAdd as a build dependency.
\n--target targetAdd as a dependency to the given target platform.
\nTo avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.
--dry-runDon’t actually write the manifest
\n--rename nameRename the dependency.
\n--optionalMark the dependency as optional.
\n--no-optionalMark the dependency as required.
\n--publicMark the dependency as public.
\nThe dependency can be referenced in your library’s public API.
\n\n--no-publicMark the dependency as private.
\nWhile you can use the crate in your implementation, it cannot be referenced in your public API.
\n\n--no-default-featuresDisable the default features.
\n--default-featuresRe-enable the default features.
\n-F features--features featuresSpace or comma separated list of features to\nactivate. When adding multiple\ncrates, the features for a specific crate may be enabled with\npackage-name/feature-name syntax. This flag may be specified multiple times,\nwhich enables all specified features.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
-p spec--package specAdd dependencies to only the specified package.
\n--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-runCompile, but don’t run benchmarks.
\n--no-fail-fastRun all benchmarks regardless of failure. Without this flag, Cargo will exit\nafter the first executable fails. The Rust test harness will run all benchmarks\nwithin the executable to completion, this flag only applies to the executable\nas a whole.
\n-p spec…--package spec…Benchmark only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceBenchmark all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libBenchmark the package’s library.
\n--bin name…Benchmark the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBenchmark all binary targets.
\n--example name…Benchmark the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBenchmark all example targets.
\n--test name…Benchmark the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBenchmark all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Benchmark the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBenchmark all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBenchmark all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBenchmark for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--profile nameBenchmark with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
-p spec…--package spec…Build only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceBuild all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libBuild the package’s library.
\n--bin name…Build the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsBuild all binary targets.
\n--example name…Build the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesBuild all example targets.
\n--test name…Build the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsBuild all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Build the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesBuild all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsBuild all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleBuild for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseBuild optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameBuild with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
--artifact-dir directoryCopy final artifacts to this directory.
\nThis option is unstable and available only on the\nnightly channel\nand requires the -Z unstable-options flag to enable.\nSee https://github.com/rust-lang/cargo/issues/6790 for more information.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo build -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo build -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-p spec…--package spec…Check only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceCheck all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libCheck the package’s library.
\n--bin name…Check the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsCheck all binary targets.
\n--example name…Check the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesCheck all example targets.
\n--test name…Check the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsCheck all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Check the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesCheck all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsCheck all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleCheck for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseCheck optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameCheck with the given profile.
\nAs a special case, specifying the test profile will also enable checking in\ntest mode which will enable checking tests and enable the test cfg option.\nSee rustc tests for more\ndetail.
See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo check -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo check -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--future-incompat-reportDisplays a future-incompat report for any future-incompatible warnings\nproduced during execution of this command
\nSee cargo-report(1)
\n-p spec…--package spec…Clean only the specified packages. This flag may be specified\nmultiple times. See cargo-pkgid(1) for the SPEC format.
\n--workspaceClean artifacts of the workspace members.
\n--dry-runDisplays a summary of what would be deleted without deleting anything.\nUse with --verbose to display the actual files that would be deleted.
--docThis option will cause cargo clean to remove only the doc directory in\nthe target directory.
--releaseRemove artifacts only in the release directory.
--profile nameRemove artifacts only in the directory with the given profile name.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
--target tupleClean for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--openOpen the docs in a browser after building them. This will use your default\nbrowser unless you define another one in the BROWSER environment variable\nor use the doc.browser configuration\noption.
--no-depsDo not build documentation for dependencies.
\n--document-private-itemsInclude non-public items in the documentation. This will be enabled by default if documenting a binary target.
\n-p spec…--package spec…Document only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceDocument all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libDocument the package’s library.
\n--bin name…Document the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsDocument all binary targets.
\n--example name…Document the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesDocument all example targets.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleDocument for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseDocument optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameDocument with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo doc -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo doc -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
--output-formatThe output type for the documentation emitted. Valid values:
\nhtml (default): Emit the documentation in HTML format.json: Emit the documentation in the experimental JSON format.This option is only available on the nightly channel\nand requires the -Z unstable-options flag to enable.
--target tupleFetch for the specified target architecture. Flag may be specified multiple times. The default is all architectures. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--broken-codeFix code even if it already has compiler errors. This is useful if cargo fix\nfails to apply the changes. It will apply the changes and leave the broken\ncode in the working directory for you to inspect and manually fix.
--editionApply changes that will update the code to the next edition. This will not\nupdate the edition in the Cargo.toml manifest, which must be updated\nmanually after cargo fix --edition has finished.
--edition-idiomsApply suggestions that will update code to the preferred style for the current\nedition.
\n--allow-no-vcsFix code even if a VCS was not detected.
\n--allow-dirtyFix code even if the working directory has changes (including staged changes).
\n--allow-stagedFix code even if the working directory has staged changes.
\n-p spec…--package spec…Fix only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspaceFix all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--libFix the package’s library.
\n--bin name…Fix the specified binary. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--binsFix all binary targets.
\n--example name…Fix the specified example. This flag may be specified multiple times\nand supports common Unix glob patterns.
\n--examplesFix all example targets.
\n--test name…Fix the specified integration test. This flag may be specified\nmultiple times and supports common Unix glob patterns.
\n--testsFix all targets that have the test = true manifest\nflag set. By default this includes the library and binaries built as\nunittests, and integration tests. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nunittest, and once as a dependency for binaries, integration tests, etc.).\nTargets may be enabled or disabled by setting the test flag in the\nmanifest settings for the target.
--bench name…Fix the specified benchmark. This flag may be specified multiple\ntimes and supports common Unix glob patterns.
\n--benchesFix all targets that have the bench = true\nmanifest flag set. By default this includes the library and binaries built\nas benchmarks, and bench targets. Be aware that this will also build any\nrequired dependencies, so the lib target may be built twice (once as a\nbenchmark, and once as a dependency for binaries, benchmarks, etc.).\nTargets may be enabled or disabled by setting the bench flag in the\nmanifest settings for the target.
--all-targetsFix all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleFix for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseFix optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameFix with the given profile.
\nAs a special case, specifying the test profile will also enable checking in\ntest mode which will enable checking tests and enable the test cfg option.\nSee rustc tests for more\ndetail.
See the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo fix -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo fix -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--publish-time yyyy-mm-ddThh:mm:ssZLatest publish time allowed for registry packages (Unstable)
\nThis is a best-effort filter on allowed packages, including:
\n--publish-time--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
Fetch information about the specified package. The spec can be a package ID, see cargo-pkgid(1) for the SPEC\nformat.\nIf the specified package is part of the current workspace, information from the local Cargo.toml file will be displayed.\nIf the Cargo.lock file does not exist, it will be created. If no version is specified, the appropriate version will be\nselected based on the Minimum Supported Rust Version (MSRV).
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--binCreate a package with a binary target (src/main.rs).\nThis is the default behavior.
--libCreate a package with a library target (src/lib.rs).
--edition editionSpecify the Rust edition to use. Default is 2024.\nPossible values: 2015, 2018, 2021, 2024
\n--name nameSet the package name. Defaults to the directory name.
\n--vcs vcsInitialize a new VCS repository for the given version control system (git,\nhg, pijul, or fossil) or do not initialize any version control at all\n(none). If not specified, defaults to git or the configuration value\ncargo-new.vcs, or none if already inside a VCS repository.
--registry registryThis sets the publish field in Cargo.toml to the given registry name\nwhich will restrict publishing only to that registry.
Registry names are defined in Cargo config files.\nIf not specified, the default registry defined by the registry.default\nconfig key is used. If the default registry is not set and --registry is not\nused, the publish field will not be set which means that publishing will not\nbe restricted.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--vers version--version versionSpecify a version to install. This may be a version\nrequirement, like ~1.2, to have Cargo\nselect the newest version from the given requirement. If the version does not\nhave a requirement operator (such as ^ or ~), then it must be in the form\nMAJOR.MINOR.PATCH, and will install exactly that version; it is not\ntreated as a caret requirement like Cargo dependencies are.
--git urlGit URL to install the specified crate from.
\n--branch branchBranch to use when installing from git.
\n--tag tagTag to use when installing from git.
\n--rev shaSpecific commit to use when installing from git.
\n--path pathFilesystem path to local crate to install from.
\n--listList all installed packages and their versions.
\n-n--dry-run(unstable) Perform all checks without installing.
\n-f--forceForce overwriting existing crates or binaries. This can be used if a package\nhas installed a binary with the same name as another package. This is also\nuseful if something has changed on the system that you want to rebuild with,\nsuch as a newer version of rustc.
--no-trackBy default, Cargo keeps track of the installed packages with a metadata file\nstored in the installation root directory. This flag tells Cargo not to use or\ncreate that file. With this flag, Cargo will refuse to overwrite any existing\nfiles unless the --force flag is used. This also disables Cargo’s ability to\nprotect against multiple concurrent invocations of Cargo installing at the\nsame time.
--bin name…Install only the specified binary.
\n--binsInstall all binaries. This is the default behavior.
\n--example name…Install only the specified example.
\n--examplesInstall all examples.
\n--root dirDirectory to install packages into.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
--index indexThe URL of the registry index to use.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleInstall for the specified target architecture. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to a new temporary folder located in the\ntemporary directory of the platform.
When using --path, by default it will use target directory in the workspace\nof the local crate unless --target-dir\nis specified.
--debugBuild with the debug profile instead of the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameInstall with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo install -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo install -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--workspaceLocate the Cargo.toml at the root of the workspace, as opposed to the current\nworkspace member.
--message-format fmtThe representation in which to print the project location. Valid values:
\njson (default): JSON object with the path under the key “root”.plain: Just the path.-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--no-depsOutput information only about the workspace members and don’t fetch\ndependencies.
\n--format-version versionSpecify the version of the output format to use. Currently 1 is the only\npossible value.
--filter-platform tupleThis filters the resolve output to only include dependencies for the\ngiven target tuple.\nA literal \"host-tuple\" can be used, which will internally be substituted by the host’s target.\nWithout this flag, the resolve includes all targets.
Note that the dependencies listed in the “packages” array still includes all\ndependencies. Each package definition is intended to be an unaltered\nreproduction of the information within Cargo.toml.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--binCreate a package with a binary target (src/main.rs).\nThis is the default behavior.
--libCreate a package with a library target (src/lib.rs).
--edition editionSpecify the Rust edition to use. Default is 2024.\nPossible values: 2015, 2018, 2021, 2024
\n--name nameSet the package name. Defaults to the directory name.
\n--vcs vcsInitialize a new VCS repository for the given version control system (git,\nhg, pijul, or fossil) or do not initialize any version control at all\n(none). If not specified, defaults to git or the configuration value\ncargo-new.vcs, or none if already inside a VCS repository.
--registry registryThis sets the publish field in Cargo.toml to the given registry name\nwhich will restrict publishing only to that registry.
Registry names are defined in Cargo config files.\nIf not specified, the default registry defined by the registry.default\nconfig key is used. If the default registry is not set and --registry is not\nused, the publish field will not be set which means that publishing will not\nbe restricted.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-a--add login…Invite the given user or team as an owner.
\n-r--remove login…Remove the given user or team as an owner.
\n-l--listList owners of a crate.
\n--token tokenAPI token to use when authenticating. This overrides the token stored in\nthe credentials file (which is created by cargo-login(1)).
\nCargo config environment variables can be\nused to override the tokens stored in the credentials file. The token for\ncrates.io may be specified with the CARGO_REGISTRY_TOKEN environment\nvariable. Tokens for other registries may be specified with environment\nvariables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME is the name\nof the registry in all capital letters.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to use. Registry names are defined in Cargo config\nfiles. If not specified, the default registry is used,\nwhich is defined by the registry.default config key which defaults to\ncrates-io.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-l--listPrint files included in a package without making one.
\n--no-verifyDon’t verify the contents by building them.
\n--no-metadataIgnore warnings about a lack of human-usable metadata (such as the description\nor the license).
\n--allow-dirtyAllow working directories with uncommitted VCS changes to be packaged.
\n--exclude-lockfileDon’t include the lock file when packaging.
\nThis flag is not for general use.\nSome tools may expect a lock file to be present (e.g. cargo install --locked).\nConsider other options before using this.
--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to package for; see cargo publish --help for more details\nabout configuration of registry names. The packages will not be published\nto this registry, but if we are packaging multiple inter-dependent crates,\nlock-files will be generated under the assumption that dependencies will be\npublished to this registry.
--message-format fmtSpecifies the output message format.\nCurrently, it only works with --list and affects the file listing format.\nThis is unstable and requires -Zunstable-options.\nValid output formats:
human (default): Display in a file-per-line format.json: Emit machine-readable JSON information about each package.\nOne package per JSON line (Newline delimited JSON).\n{\n /* The Package ID Spec of the package. */\n \"id\": \"path+file:///home/foo#0.0.0\",\n /* Files of this package */\n \"files\" {\n /* Relative path in the archive file. */\n \"Cargo.toml.orig\": {\n /* Where the file is from.\n - \"generate\" for file being generated during packaging\n - \"copy\" for file being copied from another location.\n */\n \"kind\": \"copy\",\n /* For the \"copy\" kind,\n it is an absolute path to the actual file content.\n For the \"generate\" kind,\n it is the original file the generated one is based on.\n */\n \"path\": \"/home/foo/Cargo.toml\"\n },\n \"Cargo.toml\": {\n \"kind\": \"generate\",\n \"path\": \"/home/foo/Cargo.toml\"\n },\n \"src/main.rs\": {\n \"kind\": \"copy\",\n \"path\": \"/home/foo/src/main.rs\"\n }\n }\n}\n-p spec…--package spec…Package only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspacePackage all members in the workspace.
\n--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--target tuplePackage for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo package -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo package -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p spec--package specGet the package ID for the given package instead of the current package.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--dry-runPerform all checks without uploading.
\n--no-verifyDon’t verify the contents by building them.
\n--allow-dirtyAllow working directories with uncommitted VCS changes to be packaged.
\n--index indexThe URL of the registry index to use.
\n--registry registryName of the registry to publish to. Registry names are defined in Cargo\nconfig files. If not specified, and there is a\npackage.publish field in\nCargo.toml with a single registry, then it will publish to that registry.\nOtherwise it will use the default registry, which is defined by the\nregistry.default config key\nwhich defaults to crates-io.
-p spec…--package spec…Publish only the specified packages. See cargo-pkgid(1) for the\nSPEC format. This flag may be specified multiple times and supports common Unix\nglob patterns like *, ? and []. However, to avoid your shell accidentally\nexpanding glob patterns before Cargo handles them, you must use single quotes or\ndouble quotes around each pattern.
--workspacePublish all members in the workspace.
\n--allDeprecated alias for --workspace.
--exclude SPEC…Exclude the specified packages. Must be used in conjunction with the\n--workspace flag. This flag may be specified multiple times and supports\ncommon Unix glob patterns like *, ? and []. However, to avoid your shell\naccidentally expanding glob patterns before Cargo handles them, you must use\nsingle quotes or double quotes around each pattern.
--target tuplePublish for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo publish -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo publish -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--devRemove as a development dependency.
\n--buildRemove as a build dependency.
\n--target targetRemove as a dependency to the given target platform.
\nTo avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.
--dry-runDon’t actually write to the manifest.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
-p spec…--package spec…Package to remove from.
\n+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
--id idShow the report with the specified Cargo-generated id.\nIf not specified, shows the most recent report.
\n-p spec--package specThe package to display a report for. See cargo-pkgid(1) for the SPEC\nformat.
\n-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-p spec--package specThe package to run. See cargo-pkgid(1) for the SPEC\nformat.
\n--bin nameRun the specified binary.
\n--example nameRun the specified example.
\n-F features--features featuresSpace or comma separated list of features to activate. Features of workspace\nmembers may be enabled with package-name/feature-name syntax. This flag may\nbe specified multiple times, which enables all specified features.
--all-featuresActivate all available features of all selected packages.
\n--no-default-featuresDo not activate the default feature of the selected packages.
--target tupleRun for the specified target architecture. The default is the host architecture. The general format of the tuple is\n<arch><sub>-<vendor>-<sys>-<abi>.
Possible values:
\nrustc --print target-list.\"host-tuple\", which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an xtask in a shared project that may be worked on by many hosts).This may also be specified with the build.target config value.
Note that specifying this flag makes Cargo run in a different mode where the\ntarget artifacts are placed in a separate directory. See the\nbuild cache documentation for more details.
\n-r--releaseRun optimized artifacts with the release profile.\nSee also the --profile option for choosing a specific profile by name.
--profile nameRun with the given profile.\nSee the reference for more details on profiles.
\n--timingsOutput information how long each compilation takes, and track concurrency\ninformation over time.
\nA file cargo-timing.html will be written to the target/cargo-timings\ndirectory at the end of the build. An additional report with a timestamp\nin its filename is also written if you want to look at a previous run.\nThese reports are suitable for human consumption only, and do not provide\nmachine-readable timing data.
--target-dir directoryDirectory for all generated artifacts and intermediate files. May also be\nspecified with the CARGO_TARGET_DIR environment variable, or the\nbuild.target-dir config value.\nDefaults to target in the root of the workspace.
-v--verboseUse verbose output. May be specified twice for “very verbose” output which\nincludes extra output such as dependency warnings and build script output.\nMay also be specified with the term.verbose\nconfig value.
-q--quietDo not print cargo log messages.\nMay also be specified with the term.quiet\nconfig value.
--color whenControl when colored output is used. Valid values:
\nauto (default): Automatically detect if color support is available on the\nterminal.always: Always display colors.never: Never display colors.May also be specified with the term.color\nconfig value.
--message-format fmtThe output format for diagnostic messages. Can be specified multiple times\nand consists of comma-separated values. Valid values:
\nhuman (default): Display in a human-readable text format. Conflicts with\nshort and json.short: Emit shorter, human-readable text messages. Conflicts with human\nand json.json: Emit JSON messages to stdout. See\nthe reference\nfor more details. Conflicts with human and short.json-diagnostic-short: Ensure the rendered field of JSON messages contains\nthe “short” rendering from rustc. Cannot be used with human or short.json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages\ncontains embedded ANSI color codes for respecting rustc’s default color\nscheme. Cannot be used with human or short.json-render-diagnostics: Instruct Cargo to not include rustc diagnostics\nin JSON messages printed, but instead Cargo itself should render the\nJSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others\ncoming from rustc are still emitted. Cannot be used with human or short.--manifest-path pathPath to the Cargo.toml file. By default, Cargo searches for the\nCargo.toml file in the current directory or any parent directory.
--ignore-rust-versionIgnore rust-version specification in packages.
--lockedAsserts that the exact same dependencies and versions are used as when the\nexisting Cargo.lock file was originally generated. Cargo will exit with an\nerror when either of the following scenarios arises:
It may be used in environments where deterministic builds are desired,\nsuch as in CI pipelines.
\n--offlinePrevents Cargo from accessing the network for any reason. Without this\nflag, Cargo will stop with an error if it needs to access the network and\nthe network is not available. With this flag, Cargo will attempt to\nproceed without the network if possible.
\nBeware that this may result in different dependency resolution than online\nmode. Cargo will restrict itself to crates that are downloaded locally, even\nif there might be a newer version as indicated in the local copy of the index.\nSee the cargo-fetch(1) command to download dependencies before going\noffline.
\nMay also be specified with the net.offline config value.
--frozenEquivalent to specifying both --locked and --offline.
+toolchainIf Cargo has been installed with rustup, and the first argument to cargo\nbegins with +, it will be interpreted as a rustup toolchain name (such\nas +stable or +nightly).\nSee the rustup documentation\nfor more information about how toolchain overrides work.
--config KEY=VALUE or PATHOverrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,\nor provided as a path to an extra configuration file. This flag may be specified multiple times.\nSee the command-line overrides section for more information.
-C PATHChanges the current working directory before executing any specified operations. This affects\nthings like where cargo looks by default for the project manifest (Cargo.toml), as well as\nthe directories searched for discovering .cargo/config.toml, for example. This option must\nappear before the command name, for example cargo -C path/to/my-project build.
This option is only available on the nightly\nchannel and\nrequires the -Z unstable-options flag to enable (see\n#10098).
-h--helpPrints help information.
\n-Z flagUnstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
-j N--jobs NNumber of parallel jobs to run. May also be specified with the\nbuild.jobs config value. Defaults to\nthe number of logical CPUs. If negative, it sets the maximum number of\nparallel jobs to the number of logical CPUs plus provided value. If\na string default is provided, it sets the value back to defaults.\nShould not be 0.
--keep-goingBuild as many crates in the dependency graph as possible, rather than aborting\nthe build on the first one that fails to build.
\nFor example if the current package depends on dependencies fails and works,\none of which fails to build, cargo run -j1 may or may not build the\none that succeeds (depending on which one of the two builds Cargo picked to run\nfirst), whereas cargo run -j1 --keep-going would definitely run both\nbuilds, even if the one run first fails.