CARGO(1)

📦 version 1.96.1, in ubuntu stonking

💅 CARGO(1) — the Rust package manager, but make it a group chat

okay bestie, welcome to CARGO(1), the manual page for cargo, aka The Rust package manager. She's in the General Commands Manual section and she is iconic. Sit down, hydrate, and let's get into it 🫶

✨ NAME ✨

cargo — The Rust package manager 🌸

📜 SYNOPSIS 📜

cargo [options] command [args]
cargo [options] --version
cargo [options] --list
cargo [options] --help
cargo [options] --explain code

🦋 DESCRIPTION 🦋

So this program is a package manager and a build tool for the Rust language, and it lives at <https://rust-lang.org>. She does it all, no cap.

The command you pass in may be one of these three vibes:

🛠️ COMMANDS 🛠️

🏗️ Build Commands

  • cargo-bench(1) — Execute benchmarks of a package. 📊
  • cargo-build(1) — Compile a package.
  • cargo-check(1) — Check a local package and all of its dependencies for errors. 👀
  • cargo-clean(1) — Remove artifacts that Cargo has generated in the past. 🧹
  • cargo-doc(1) — Build a package’s documentation. 📚
  • cargo-fetch(1) — Fetch dependencies of a package from the network. 🌐
  • cargo-fix(1) — Automatically fix lint warnings reported by rustc. 🔧
  • cargo-run(1) — Run a binary or example of the local package. 🏃
  • cargo-rustc(1) — Compile a package, and pass extra options to the compiler.
  • cargo-rustdoc(1) — Build a package’s documentation, using specified custom flags.
  • cargo-test(1) — Execute unit and integration tests of a package. ✅

📋 Manifest Commands

📦 Package Commands

🚀 Publishing Commands

📈 Report Commands

🧭 General Commands

⚙️ OPTIONS ⚙️

🌟 Special Options

  • -V, --version — Print version info and exit. If used with --verbose, prints extra information.
  • --list — List all installed Cargo subcommands. If used with --verbose, prints extra information.
  • --explain code — Run rustc --explain CODE which will print out a detailed explanation of an error message (for example, E0004). 🧠

🎨 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>.

🔒 Manifest Options

  • --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 when either of the following scenarios arises:
    • The lock file is missing.
    • Cargo attempted to change the lock file due to a different dependency resolution.

It may be used in environments where deterministic builds are desired, such as in CI pipelines. 🎯

  • --offline — 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.
Beware bestie ⚠️ 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 cargo-fetch(1) command to 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. ❄️

🫶 Common Options

  • +toolchain — If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). See the rustup documentation <https://rust-lang.github.io/rustup/overrides.html> for more information about how toolchain overrides work.
  • --config KEY=VALUE or PATH — Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided 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 information.
  • -C PATH — Changes the current working directory before executing any specified operations. This affects things 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.
heads up 🙈 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. 🆘
  • -Z flag — Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details. 🌙

🌍 ENVIRONMENT 🌍

See the reference <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for details on environment variables that Cargo reads. 👀

🚦 EXIT STATUS 🚦

  • 0: Cargo succeeded. 🎉
  • 101: Cargo failed to complete. 💀

📁 FILES 📁

  • ~/.cargo/ — Default location for Cargo’s “home” directory where it stores various files. The location can be changed with the CARGO_HOME environment variable.
  • $CARGO_HOME/bin/ — Binaries installed by cargo-install(1) will be located here. If using rustup <https://rust-lang.github.io/rustup/>, executables distributed with Rust are also located here.
  • $CARGO_HOME/config.toml — The global configuration file. See the reference <https://doc.rust-lang.org/cargo/reference/config.html> for more information about configuration files.
  • .cargo/config.toml — Cargo automatically searches for a file named .cargo/config.toml in the current directory, and all parent directories. These configuration files will be merged with the global configuration file.
  • $CARGO_HOME/credentials.toml — Private authentication information for logging in to a registry. 🔐
  • $CARGO_HOME/registry/ — This directory contains cached downloads of the registry index and any downloaded dependencies.
  • $CARGO_HOME/git/ — This directory contains cached downloads of git dependencies.
Please note that the internal structure of the $CARGO_HOME directory is not stable yet and may be subject to change. 🫠

🌸 EXAMPLES 🌸

  1. Build a local package and all of its dependencies:
cargo build
  1. Build a package with optimizations:
cargo build --release
  1. Run tests for a cross-compiled target:
cargo test --target i686-unknown-linux-gnu
  1. Create a new package that builds an executable:
cargo new foobar
  1. Create a package in the current directory:
mkdir foo && cd foo
cargo init .
  1. Learn about a command’s options and usage:
cargo help clean

🐛 BUGS 🐛

See <https://github.com/rust-lang/cargo/issues> for issues. fr fr, if something's broken, that's the place 🫡

👀 SEE ALSO 👀

rustc(1), rustdoc(1)

and that's the whole page bestie 💖 this was the CARGO(1) page from the General Commands Manual — footer says CARGO(1) too, so yeah, she's got main character energy from top to bottom 👑 go build something cute, mwah 🎀✨

📦 where this page comes from