CARGO(1)

📦 version 1.92.0, in ubuntu resolute

💖 CARGO(1) 💖

okay bestie, welcome to the General Commands Manual, this is the CARGO(1) page and honestly? it's the main character of the whole Rust ecosystem. buckle up, we're reading a manpage and we're gonna enjoy it 🎀

✨ NAME ✨

cargo — The Rust package manager. that's it, that's the vibe. 👑

🦋 SYNOPSIS 🦋

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

like. it's giving "one binary, infinite possibilities". ✨

🌸 DESCRIPTION 🌸

okay so real talk: this program is a package manager and a build tool for the Rust language, and you can find it at <https://rust-lang.org>. it literally does your dependency wrangling, your compiling, your testing, your publishing. everything. iconic behaviour, no notes. 💅

🔥 COMMANDS 🔥

🛠️ Build Commands

  • cargo-bench(1) — Execute benchmarks of a package. yes queen, time your code. ⏱️
  • cargo-build(1) — Compile a package. the classic. the blueprint. 💖
  • cargo-check(1) — Check a local package and all of its dependencies for errors. faster than a full build, less drama. ✨
  • cargo-clean(1) — Remove artifacts that Cargo has generated in the past. spring cleaning but for your target dir. 🧹
  • cargo-doc(1) — Build a package's documentation. give the people docs. 🎀
  • cargo-fetch(1) — Fetch dependencies of a package from the network. go get 'em. 🌐
  • cargo-fix(1) — Automatically fix lint warnings reported by rustc. rustc complains, cargo says "i got u bestie". 🩹
  • cargo-run(1) — Run a binary or example of the local package. hit play. ▶️
  • cargo-rustc(1) — Compile a package, and pass extra options to the compiler. for when you wanna talk directly to the compiler. 🗣️
  • cargo-rustdoc(1) — Build a package's documentation, using specified custom flags. same energy, custom flags. 🚩
  • cargo-test(1) — Execute unit and integration tests of a package. trust but verify. ✅

📜 Manifest Commands

  • cargo-add(1) — Add dependencies to a Cargo.toml manifest file. ✍️
  • cargo-generate-lockfile(1) — Generate Cargo.lock for a project. 🔒
  • cargo-info(1) — Display information about a package in the registry. Default registry is crates.io. 🔍
  • cargo-locate-project(1) — Print a JSON representation of a Cargo.toml file's location. 🗺️
  • cargo-metadata(1) — Output the resolved dependencies of a package in machine-readable format. 🤖
  • cargo-pkgid(1) — Print a fully qualified package specification. 🪪
  • cargo-remove(1) — Remove dependencies from a Cargo.toml manifest file. it's giving "we don't need that anymore". 🗑️
  • cargo-tree(1) — Display a tree visualization of a dependency graph. pretty little dependency forest 🌳
  • cargo-update(1) — Update dependencies as recorded in the local lock file. 🔄
  • cargo-vendor(1) — Vendor all dependencies locally. bring them all home. 🏠

📦 Package Commands

🚀 Publishing Commands

  • cargo-login(1) — Save an API token from the registry locally. 🔑
  • cargo-logout(1) — Remove an API token from the registry locally. log off, log off 🚪
  • cargo-owner(1) — Manage the owners of a crate on the registry. 👥
  • cargo-package(1) — Assemble the local package into a distributable tarball. 📁
  • cargo-publish(1) — Upload a package to the registry. the moment we've all been waiting for 🎉
  • cargo-yank(1) — Remove a pushed crate from the index. rip bozo 💀

🧚 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). like a translator for cryptic compiler yelling 🫶

🌈 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 at <https://doc.rust-lang.org/cargo/reference/config.html>. (yes, very verbose is a real thing, it's a whole mood 🗣️)
  • -q, --quiet — Do not print cargo log messages. May also be specified with the term.quiet config value at <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 at <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. (fr fr, your CI will thank u) 🧷

  • --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 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 cargo-fetch(1) command to download dependencies before going offline.

May also be specified with the net.offline config value at <https://doc.rust-lang.org/cargo/reference/config.html>. ✈️

  • --frozen — Equivalent to specifying both --locked and --offline. the combo meal 🍔

🎀 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 at <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 at <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.
🙈 This option is only available on the nightly channel at <https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> and requires the -Z unstable-options flag to enable (see #10098 at <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 at <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for details on environment variables that Cargo reads. 👀

✅ EXIT STATUS ✅

  • 0: Cargo succeeded. slay 🎉
  • 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 at <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 at <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

like. the range. the versatility. obsessed. 💖

🐛 BUGS 🐛

See <https://github.com/rust-lang/cargo/issues> for issues. found a bug? tell the maintainers, they're nice, no cap. 🫶

👀 SEE ALSO 👀

rustc(1), rustdoc(1)

and that's the whole page bestie!! 🎀 this was the CARGO(1) page from the General Commands Manual — the last line just says CARGO(1) again, because the footer is literally just the page name, and honestly? iconic of it to be that self-confident. go forth and cargo build something beautiful. 💜🦋✨

📦 where this page comes from