CARGO-BUILD(1)

📦 version 1.92.0, in ubuntu resolute

🎀 CARGO-BUILD(1) 🎀

✨ NAME ✨

cargo-build — Compile the current package 💖

✨ SYNOPSIS ✨

cargo build [options]

✨ DESCRIPTION ✨

Compile local packages and all of their dependencies. No cap, that's the whole vibe. 🫶

✨ OPTIONS ✨

💅 Package Selection 💅

okay so bestie, when no package selection options are given, the packages selected depend on the selected manifest file (based on the current working directory if --manifest-path is not given). If the manifest is the root of a workspace then the workspace's default members are selected, otherwise only the package defined by the manifest will be selected.

The default members of a workspace can be set explicitly with the workspace.default-members key in the root manifest. If this is not set, a virtual workspace will include all workspace members (equivalent to passing --workspace), and a non-virtual workspace will include only the root crate itself. periodt.

  • -p spec…, --package spec… — Build only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally expanding glob patterns before Cargo handles them, you must use single quotes or double quotes around each pattern. 💅
  • --workspace — Build all members in the workspace.
  • --all — Deprecated alias for --workspace.
  • --exclude SPEC… — Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally expanding glob patterns before Cargo handles them, you must use single quotes or double quotes around each pattern.

🎯 Target Selection 🎯

When no target selection options are given, cargo build will build all binary and library targets of the selected packages. Binaries are skipped if they have required-features that are missing. fr fr.

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 CARGO_BIN_EXE_<name> environment variable 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 env macro https://doc.rust-lang.org/std/macro.env.html to locate the executable.

Passing target selection flags will build only the specified targets. iykyk ✨

Note that --bin, --example, --test and --bench flags also support common Unix glob patterns like *, ? and []. 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.

  • --lib — Build the package's library.
  • --bin name… — Build the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.
  • --bins — Build all binary targets.
  • --example name… — Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
  • --examples — Build all example targets.
  • --test name… — Build the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.
  • --tests — Build all targets that have the test = true 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 test flag in the manifest settings for the target.
  • --bench name… — Build the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.
  • --benches — Build all targets that have the bench = true 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 bench flag in the manifest settings for the target.
  • --all-targets — Build all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.

🌈 Feature Selection 🌈

The feature flags allow you to control which features are enabled. When no feature options are given, the default feature is activated for every selected package. slay 💖

See the features documentation https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options for more details.

  • -F features, --features features — Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.
  • --all-features — Activate all available features of all selected packages.
  • --no-default-features — Do not activate the default feature of the selected packages.

🔧 Compilation Options 🔧

  • --target triple — Build for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

Possible values:

  • Any supported target in rustc --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).
  • A path to a custom target specification. See Custom Target Lookup Path https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path for more information.

This may also be specified with the build.target config value https://doc.rust-lang.org/cargo/reference/config.html.

Note that specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. See the build cache https://doc.rust-lang.org/cargo/reference/build-cache.html documentation for more details.

  • -r, --release — Build optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.
  • --profile name — Build with the given profile. See the reference https://doc.rust-lang.org/cargo/reference/profiles.html for more details on profiles.
  • --timings=fmts — Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. Specifying an output format (rather than the default) is unstable and requires -Zunstable-options. Valid output formats:
    • html (unstable, requires -Zunstable-options): Write a human-readable file cargo-timing.html to the target/cargo-timings 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.
    • json (unstable, requires -Zunstable-options): Emit machine-readable JSON information about timing information.

📦 Output Options 📦

  • --target-dir directory — Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value https://doc.rust-lang.org/cargo/reference/config.html. Defaults to target in the root of the workspace.
  • --artifact-dir directory — Copy final artifacts to this directory.

This option is unstable and available only on the nightly channel https://doc.rust-lang.org/book/appendix-07-nightly-rust.html and requires the -Z unstable-options flag to enable. See https://github.com/rust-lang/cargo/issues/6790 for more information.

🖥️ Display Options 🖥️

  • -v, --verbose — Use verbose output. May be specified twice for "very verbose" output which includes extra output such as dependency warnings and build script output. May also be specified with the term.verbose config value https://doc.rust-lang.org/cargo/reference/config.html.
  • -q, --quiet — Do not print cargo log messages. May also be specified with the term.quiet config value https://doc.rust-lang.org/cargo/reference/config.html.
  • --color when — Control when colored output is used. Valid values:
    • auto (default): Automatically detect if color support is available on the terminal.
    • always: Always display colors.
    • never: Never display colors.

May also be specified with the term.color config value https://doc.rust-lang.org/cargo/reference/config.html.

  • --message-format fmt — The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:
    • human (default): Display in a human-readable text format. Conflicts with short and json.
    • short: Emit shorter, human-readable text messages. Conflicts with human and json.
    • json: Emit JSON messages to stdout. See the reference https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages for more details. Conflicts with human and short.
    • json-diagnostic-short: Ensure the rendered field of JSON messages contains the "short" rendering from rustc. Cannot be used with human or short.
    • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting rustc's default color scheme. Cannot be used with human or short.
  • json-render-diagnostics — tells Cargo to not shove rustc diagnostics into the JSON messages it prints, and instead have Cargo itself render the JSON diagnostics that come in from rustc. Cargo's own JSON diagnostics, plus the other ones coming from rustc, still get emitted. Can't be combined with human or short. no mixing bestie 💅
  • --build-plan — spits out a whole series of JSON messages to stdout that lay out the commands to run the build. it's giving "here's the plan, queen"
okay so this one is unstable, only available on the nightly channel (https://doc.rust-lang.org/book/appendix-07-nightly-rust.html) and it needs the -Z unstable-options flag to even turn on. More info at https://github.com/rust-lang/cargo/issues/5579 👀

🗂️ Manifest Options 🗂️

  • --manifest-path path — the path to the Cargo.toml file. By default Cargo goes hunting for Cargo.toml in the current directory, and if it's not there, up through every parent directory like a lil detective 🕵️‍♀️
  • --ignore-rust-version — ignores the rust-version specification in packages. pretend you didn't see it ✨
  • --locked — asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error whenever either of these scenarios shows up:
    • the lock file is missing. 💀
    • Cargo attempted to change the lock file because of a different dependency resolution.

It may be used in environments where deterministic builds are the whole point, like in CI pipelines. reproducible queen behavior fr fr

  • --offline — stops Cargo from accessing the network for any reason. Without this flag, Cargo will stop with an error if it needs the network and the network just isn't there. With this flag, Cargo will attempt to proceed without the network if it possibly can.
beware bestie ⚠️ this may result in a 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. Peep cargo-fetch(1) if you wanna download dependencies before going offline.

May also be specified with the net.offline config value (https://doc.rust-lang.org/cargo/reference/config.html).

  • --frozen — equivalent to specifying both --locked and --offline. two flags in a trench coat 🧥
  • --lockfile-path PATH — changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore the existing lockfile at the default path, and instead will either use the lockfile from PATH, or write a new lockfile into the provided PATH if it doesn't exist. This flag can be used to run most commands in read-only directories, writing the lockfile into the provided PATH. read-only dir? we still eating 🍓
this option is only available on the nightly channel (https://doc.rust-lang.org/book/appendix-07-nightly-rust.html) and requires the -Z unstable-options flag to enable (see #14421 https://github.com/rust-lang/cargo/issues/14421).

🌈 Common Options 🌈

  • +toolchain — if Cargo has been installed with rustup, and the first argument to cargo begins with +, it gets interpreted as a rustup toolchain name (things like +stable or +nightly). See the rustup documentation (https://rust-lang.github.io/rustup/overrides.html) for more about how toolchain overrides work. mix and match, iconic ✨
  • --config KEY=VALUE or PATH — overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or given as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section (https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides) for more info.
  • -C PATH — changes the current working directory before executing any specified operations. This affects stuff like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must appear before the command name, for example cargo -C path/to/my-project build. order matters, don't play yourself 🙈
this option is only available on the nightly channel (https://doc.rust-lang.org/book/appendix-07-nightly-rust.html) and requires the -Z unstable-options flag to enable (see #10098 https://github.com/rust-lang/cargo/issues/10098).
  • -h, --help — prints help information. your bestie when you're lost 💛
  • -Z flag — unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

🎀 Miscellaneous Options 🎀

  • -j N, --jobs N — number of parallel jobs to run. May also be specified with the build.jobs config value (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 the provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. literally do not put 0, bestie 💀
  • --keep-going — builds as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

For example if the current package depends on dependencies fails and works, one of which fails to build, cargo build -j1 may or may not build the one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo build -j1 --keep-going would definitely run both builds, even if the one run first fails. we persist 🫶

  • --future-incompat-report — displays a future-incompat report for any future-incompatible warnings produced during execution of this command. a lil heads-up from the future 🔮

See cargo-report(1)

🌍 ENVIRONMENT 🌍

See the reference (https://doc.rust-lang.org/cargo/reference/environment-variables.html) for details on environment variables that Cargo reads. iykyk 📖

🚦 EXIT STATUS 🚦

  • 0: Cargo succeeded. slay ✅
  • 101: Cargo failed to complete. oof 😭

✨ EXAMPLES ✨

  1. Build the local package and all of its dependencies:
cargo build
  1. Build with optimizations:
cargo build --release

that's it, that's the whole vibe 👑

👀 SEE ALSO 👀

cargo(1), cargo-rustc(1)

and that's the whole page, bestie — this was CARGO-BUILD(1) 💖 straight out of the Cargo manual, so go build something iconic 🌸✨

📦 where this page comes from