| '\" t |
| .TH "CARGO\-BUILD" "1" |
| .nh |
| .ad l |
| .ss \n[.ss] 0 |
| .SH "NAME" |
| cargo\-build \[em] Compile the current package |
| .SH "SYNOPSIS" |
| \fBcargo build\fR [\fIoptions\fR] |
| .SH "DESCRIPTION" |
| Compile local packages and all of their dependencies. |
| .SH "OPTIONS" |
| .SS "Package Selection" |
| By default, when no package selection options are given, the packages selected |
| depend on the selected manifest file (based on the current working directory if |
| \fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then |
| the workspaces default members are selected, otherwise only the package defined |
| by the manifest will be selected. |
| .sp |
| The default members of a workspace can be set explicitly with the |
| \fBworkspace.default\-members\fR key in the root manifest. If this is not set, a |
| virtual workspace will include all workspace members (equivalent to passing |
| \fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. |
| .sp |
| \fB\-p\fR \fIspec\fR\[u2026], |
| \fB\-\-package\fR \fIspec\fR\[u2026] |
| .RS 4 |
| Build only the specified packages. See \fBcargo\-pkgid\fR(1) for the |
| SPEC format. This flag may be specified multiple times and supports common Unix |
| glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally |
| expanding glob patterns before Cargo handles them, you must use single quotes or |
| double quotes around each pattern. |
| .RE |
| .sp |
| \fB\-\-workspace\fR |
| .RS 4 |
| Build all members in the workspace. |
| .RE |
| .sp |
| \fB\-\-all\fR |
| .RS 4 |
| Deprecated alias for \fB\-\-workspace\fR\&. |
| .RE |
| .sp |
| \fB\-\-exclude\fR \fISPEC\fR\[u2026] |
| .RS 4 |
| Exclude the specified packages. Must be used in conjunction with the |
| \fB\-\-workspace\fR flag. This flag may be specified multiple times and supports |
| common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell |
| accidentally expanding glob patterns before Cargo handles them, you must use |
| single quotes or double quotes around each pattern. |
| .RE |
| .SS "Target Selection" |
| When no target selection options are given, \fBcargo build\fR will build all |
| binary and library targets of the selected packages. Binaries are skipped if |
| they have \fBrequired\-features\fR that are missing. |
| .sp |
| Binary targets are automatically built if there is an integration test or |
| benchmark being selected to build. This allows an integration |
| test to execute the binary to exercise and test its behavior. |
| The \fBCARGO_BIN_EXE_<name>\fR |
| \fIenvironment variable\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html#environment\-variables\-cargo\-sets\-for\-crates> |
| is set when the integration test is built so that it can use the |
| \fI\f(BIenv\fI macro\fR <https://doc.rust\-lang.org/std/macro.env.html> to locate the |
| executable. |
| .sp |
| Passing target selection flags will build only the specified |
| targets. |
| .sp |
| Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also |
| support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your |
| shell accidentally expanding glob patterns before Cargo handles them, you must |
| use single quotes or double quotes around each glob pattern. |
| .sp |
| \fB\-\-lib\fR |
| .RS 4 |
| Build the package\[cq]s library. |
| .RE |
| .sp |
| \fB\-\-bin\fR \fIname\fR\[u2026] |
| .RS 4 |
| Build the specified binary. This flag may be specified multiple times |
| and supports common Unix glob patterns. |
| .RE |
| .sp |
| \fB\-\-bins\fR |
| .RS 4 |
| Build all binary targets. |
| .RE |
| .sp |
| \fB\-\-example\fR \fIname\fR\[u2026] |
| .RS 4 |
| Build the specified example. This flag may be specified multiple times |
| and supports common Unix glob patterns. |
| .RE |
| .sp |
| \fB\-\-examples\fR |
| .RS 4 |
| Build all example targets. |
| .RE |
| .sp |
| \fB\-\-test\fR \fIname\fR\[u2026] |
| .RS 4 |
| Build the specified integration test. This flag may be specified |
| multiple times and supports common Unix glob patterns. |
| .RE |
| .sp |
| \fB\-\-tests\fR |
| .RS 4 |
| Build all targets in test mode that have the \fBtest = true\fR manifest |
| flag set. By default this includes the library and binaries built as |
| unittests, and integration tests. Be aware that this will also build any |
| required dependencies, so the lib target may be built twice (once as a |
| unittest, and once as a dependency for binaries, integration tests, etc.). |
| Targets may be enabled or disabled by setting the \fBtest\fR flag in the |
| manifest settings for the target. |
| .RE |
| .sp |
| \fB\-\-bench\fR \fIname\fR\[u2026] |
| .RS 4 |
| Build the specified benchmark. This flag may be specified multiple |
| times and supports common Unix glob patterns. |
| .RE |
| .sp |
| \fB\-\-benches\fR |
| .RS 4 |
| Build all targets in benchmark mode that have the \fBbench = true\fR |
| manifest flag set. By default this includes the library and binaries built |
| as benchmarks, and bench targets. Be aware that this will also build any |
| required dependencies, so the lib target may be built twice (once as a |
| benchmark, and once as a dependency for binaries, benchmarks, etc.). |
| Targets may be enabled or disabled by setting the \fBbench\fR flag in the |
| manifest settings for the target. |
| .RE |
| .sp |
| \fB\-\-all\-targets\fR |
| .RS 4 |
| Build all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&. |
| .RE |
| .SS "Feature Selection" |
| The feature flags allow you to control which features are enabled. When no |
| feature options are given, the \fBdefault\fR feature is activated for every |
| selected package. |
| .sp |
| See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options> |
| for more details. |
| .sp |
| \fB\-F\fR \fIfeatures\fR, |
| \fB\-\-features\fR \fIfeatures\fR |
| .RS 4 |
| Space or comma separated list of features to activate. Features of workspace |
| members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may |
| be specified multiple times, which enables all specified features. |
| .RE |
| .sp |
| \fB\-\-all\-features\fR |
| .RS 4 |
| Activate all available features of all selected packages. |
| .RE |
| .sp |
| \fB\-\-no\-default\-features\fR |
| .RS 4 |
| Do not activate the \fBdefault\fR feature of the selected packages. |
| .RE |
| .SS "Compilation Options" |
| .sp |
| \fB\-\-target\fR \fItriple\fR |
| .RS 4 |
| Build for the given architecture. The default is the host architecture. The general format of the triple is |
| \fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a |
| list of supported targets. This flag may be specified multiple times. |
| .sp |
| This may also be specified with the \fBbuild.target\fR |
| \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| .sp |
| Note that specifying this flag makes Cargo run in a different mode where the |
| target artifacts are placed in a separate directory. See the |
| \fIbuild cache\fR <https://doc.rust\-lang.org/cargo/guide/build\-cache.html> documentation for more details. |
| .RE |
| .sp |
| \fB\-r\fR, |
| \fB\-\-release\fR |
| .RS 4 |
| Build optimized artifacts with the \fBrelease\fR profile. |
| See also the \fB\-\-profile\fR option for choosing a specific profile by name. |
| .RE |
| .sp |
| \fB\-\-profile\fR \fIname\fR |
| .RS 4 |
| Build with the given profile. |
| See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more details on profiles. |
| .RE |
| .sp |
| \fB\-\-ignore\-rust\-version\fR |
| .RS 4 |
| Build the target even if the selected Rust compiler is older than the |
| required Rust version as configured in the project\[cq]s \fBrust\-version\fR field. |
| .RE |
| .sp |
| \fB\-\-timings=\fR\fIfmts\fR |
| .RS 4 |
| Output information how long each compilation takes, and track concurrency |
| information over time. Accepts an optional comma\-separated list of output |
| formats; \fB\-\-timings\fR without an argument will default to \fB\-\-timings=html\fR\&. |
| Specifying an output format (rather than the default) is unstable and requires |
| \fB\-Zunstable\-options\fR\&. Valid output formats: |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBhtml\fR (unstable, requires \fB\-Zunstable\-options\fR): Write a human\-readable file \fBcargo\-timing.html\fR to the |
| \fBtarget/cargo\-timings\fR directory with a report of the compilation. Also write |
| a report to the same directory with a timestamp in the filename if you want |
| to look at older runs. HTML output is suitable for human consumption only, |
| and does not provide machine\-readable timing data. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBjson\fR (unstable, requires \fB\-Zunstable\-options\fR): Emit machine\-readable JSON |
| information about timing information. |
| .RE |
| .RE |
| .SS "Output Options" |
| .sp |
| \fB\-\-target\-dir\fR \fIdirectory\fR |
| .RS 4 |
| Directory for all generated artifacts and intermediate files. May also be |
| specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the |
| \fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| Defaults to \fBtarget\fR in the root of the workspace. |
| .RE |
| .sp |
| \fB\-\-out\-dir\fR \fIdirectory\fR |
| .RS 4 |
| Copy final artifacts to this directory. |
| .sp |
| This option is unstable and available only on the |
| \fInightly channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> |
| and requires the \fB\-Z unstable\-options\fR flag to enable. |
| See <https://github.com/rust\-lang/cargo/issues/6790> for more information. |
| .RE |
| .SS "Display Options" |
| .sp |
| \fB\-v\fR, |
| \fB\-\-verbose\fR |
| .RS 4 |
| Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which |
| includes extra output such as dependency warnings and build script output. |
| May also be specified with the \fBterm.verbose\fR |
| \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| .RE |
| .sp |
| \fB\-q\fR, |
| \fB\-\-quiet\fR |
| .RS 4 |
| Do not print cargo log messages. |
| May also be specified with the \fBterm.quiet\fR |
| \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| .RE |
| .sp |
| \fB\-\-color\fR \fIwhen\fR |
| .RS 4 |
| Control when colored output is used. Valid values: |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBauto\fR (default): Automatically detect if color support is available on the |
| terminal. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBalways\fR: Always display colors. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBnever\fR: Never display colors. |
| .RE |
| .sp |
| May also be specified with the \fBterm.color\fR |
| \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| .RE |
| .sp |
| \fB\-\-message\-format\fR \fIfmt\fR |
| .RS 4 |
| The output format for diagnostic messages. Can be specified multiple times |
| and consists of comma\-separated values. Valid values: |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with |
| \fBshort\fR and \fBjson\fR\&. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR |
| and \fBjson\fR\&. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBjson\fR: Emit JSON messages to stdout. See |
| \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages> |
| for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains |
| the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages |
| contains embedded ANSI color codes for respecting rustc\[cq]s default color |
| scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics |
| in JSON messages printed, but instead Cargo itself should render the |
| JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others |
| coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. |
| .RE |
| .RE |
| .sp |
| \fB\-\-build\-plan\fR |
| .RS 4 |
| Outputs a series of JSON messages to stdout that indicate the commands to run |
| the build. |
| .sp |
| This option is unstable and available only on the |
| \fInightly channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> |
| and requires the \fB\-Z unstable\-options\fR flag to enable. |
| See <https://github.com/rust\-lang/cargo/issues/5579> for more information. |
| .RE |
| .SS "Manifest Options" |
| .sp |
| \fB\-\-manifest\-path\fR \fIpath\fR |
| .RS 4 |
| Path to the \fBCargo.toml\fR file. By default, Cargo searches for the |
| \fBCargo.toml\fR file in the current directory or any parent directory. |
| .RE |
| .sp |
| \fB\-\-frozen\fR, |
| \fB\-\-locked\fR |
| .RS 4 |
| Either of these flags requires that the \fBCargo.lock\fR file is |
| up\-to\-date. If the lock file is missing, or it needs to be updated, Cargo will |
| exit with an error. The \fB\-\-frozen\fR flag also prevents Cargo from |
| attempting to access the network to determine if it is out\-of\-date. |
| .sp |
| These may be used in environments where you want to assert that the |
| \fBCargo.lock\fR file is up\-to\-date (such as a CI build) or want to avoid network |
| access. |
| .RE |
| .sp |
| \fB\-\-offline\fR |
| .RS 4 |
| Prevents Cargo from accessing the network for any reason. Without this |
| flag, Cargo will stop with an error if it needs to access the network and |
| the network is not available. With this flag, Cargo will attempt to |
| proceed without the network if possible. |
| .sp |
| Beware that this may result in different dependency resolution than online |
| mode. Cargo will restrict itself to crates that are downloaded locally, even |
| if there might be a newer version as indicated in the local copy of the index. |
| See the \fBcargo\-fetch\fR(1) command to download dependencies before going |
| offline. |
| .sp |
| May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| .RE |
| .SS "Common Options" |
| .sp |
| \fB+\fR\fItoolchain\fR |
| .RS 4 |
| If Cargo has been installed with rustup, and the first argument to \fBcargo\fR |
| begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such |
| as \fB+stable\fR or \fB+nightly\fR). |
| See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html> |
| for more information about how toolchain overrides work. |
| .RE |
| .sp |
| \fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR |
| .RS 4 |
| Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, |
| or provided as a path to an extra configuration file. This flag may be specified multiple times. |
| See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information. |
| .RE |
| .sp |
| \fB\-C\fR \fIPATH\fR |
| .RS 4 |
| Changes the current working directory before executing any specified operations. This affects |
| things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as |
| the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must |
| appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. |
| .sp |
| This option is only available on the \fInightly |
| channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and |
| requires the \fB\-Z unstable\-options\fR flag to enable (see |
| \fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>). |
| .RE |
| .sp |
| \fB\-h\fR, |
| \fB\-\-help\fR |
| .RS 4 |
| Prints help information. |
| .RE |
| .sp |
| \fB\-Z\fR \fIflag\fR |
| .RS 4 |
| Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. |
| .RE |
| .SS "Miscellaneous Options" |
| .sp |
| \fB\-j\fR \fIN\fR, |
| \fB\-\-jobs\fR \fIN\fR |
| .RS 4 |
| Number of parallel jobs to run. May also be specified with the |
| \fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to |
| the number of logical CPUs. If negative, it sets the maximum number of |
| parallel jobs to the number of logical CPUs plus provided value. If |
| a string \fBdefault\fR is provided, it sets the value back to defaults. |
| Should not be 0. |
| .RE |
| .sp |
| \fB\-\-keep\-going\fR |
| .RS 4 |
| Build as many crates in the dependency graph as possible, rather than aborting |
| the build on the first one that fails to build. |
| .sp |
| For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR, |
| one of which fails to build, \fBcargo build \-j1\fR may or may not build the |
| one that succeeds (depending on which one of the two builds Cargo picked to run |
| first), whereas \fBcargo build \-j1 \-\-keep\-going\fR would definitely run both |
| builds, even if the one run first fails. |
| .RE |
| .sp |
| \fB\-\-future\-incompat\-report\fR |
| .RS 4 |
| Displays a future\-incompat report for any future\-incompatible warnings |
| produced during execution of this command |
| .sp |
| See \fBcargo\-report\fR(1) |
| .RE |
| .SH "ENVIRONMENT" |
| See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for |
| details on environment variables that Cargo reads. |
| .SH "EXIT STATUS" |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fB0\fR: Cargo succeeded. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fB101\fR: Cargo failed to complete. |
| .RE |
| .SH "EXAMPLES" |
| .sp |
| .RS 4 |
| \h'-04' 1.\h'+01'Build the local package and all of its dependencies: |
| .sp |
| .RS 4 |
| .nf |
| cargo build |
| .fi |
| .RE |
| .RE |
| .sp |
| .RS 4 |
| \h'-04' 2.\h'+01'Build with optimizations: |
| .sp |
| .RS 4 |
| .nf |
| cargo build \-\-release |
| .fi |
| .RE |
| .RE |
| .SH "SEE ALSO" |
| \fBcargo\fR(1), \fBcargo\-rustc\fR(1) |