CARGO-RUN(1)

📦 version 1.92.0, in ubuntu resolute

👑 cargo-run — Run the current package

okay bestie, welcome to the manual page for cargo-run (that's CARGO-RUN(1) if you're being formal, which we are not 💅). She's a general commands manual page and she is iconic. Let's get into it.

✨ NAME ✨

cargo-run — Run the current package 🏃♀️💨

🌸 SYNOPSIS 🌸

cargo run [options] [-- args]

🦋 DESCRIPTION 🦋

Runs a binary or an example from your local package. That's the whole vibe. 🎀

Every single argument that comes after the two dashes (--) gets handed off to the binary you're running. And here's the thing, bestie, because this trips everyone up: if you're passing arguments to both Cargo and the binary, the ones after -- go to the binary, and the ones before -- go to Cargo. Periodt.

Unlike cargo-test(1) and cargo-bench(1), cargo run sets the working directory of the binary it executes to the current working directory — same as if you'd run it in the shell directly. No sneaky directory changes. Slay. ✨

💖 OPTIONS 💖

📦 Package Selection

By default, it's the package sitting in your current working directory that gets selected. But if you want a different package in a workspace, the -p flag is your girl.

  • -p spec, --package spec — The package to run. Peep cargo-pkgid(1) for the SPEC format. 👀

🎯 Target Selection

When you don't pass any target selection options, cargo run will run the binary target. If there are multiple binary targets, you must pass a target flag to pick one. OR — and this is lowkey the move — the default-run field can be specified in the [package] section of Cargo.toml to choose the name of the binary that runs by default. 🌟

  • --bin name — Run the specified binary. 🏃
  • --example name — Run the specified example. 📓

🎀 Feature Selection

Feature flags let you control which features get enabled. When you don't give any feature options, the default feature is activated for every selected package.

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

  • -F features, --features features — A space- or comma-separated list of features to activate. Features of workspace members can be enabled with the package-name/feature-name syntax. This flag can be specified multiple times, and doing so enables all the specified features. 🫶
  • --all-features — Activate all available features of all selected packages. Go big or go home.
  • --no-default-features — Do not activate the default feature of the selected packages. 🙈

🔨 Compilation Options

  • --target triple — Run for the specified target architecture. 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>.

Heads up bestie: specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. See the build cache documentation <https://doc.rust-lang.org/cargo/reference/build-cache.html> for more details. 💀
  • -r, --release — Run optimized artifacts with the release profile. Also peep the --profile option if you wanna choose a specific profile by name. 🔥
  • --profile name — Run 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 about 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. 🗂️

🗣️ Display Options

  • -v, --verbose — Use verbose output. Can 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: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.

📜 Manifest Options

  • --manifest-path path — Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory. 🔍
  • --ignore-rust-version — Ignore rust-version specification in packages. 🙈
  • --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 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. 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. Two for one, we love a bundle. 🧊
  • --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.
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 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. 📍

and that's part one, bestie — there's more coming, so don't go anywhere 🫶

This one's only on the nightly channel <https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> bestie, and it needs the -Z unstable-options flag switched on to even show up (peep #10098 <https://github.com/rust-lang/cargo/issues/10098> if you wanna read the lore 💀).

  • -h, --help — prints help information. That's it, that's the whole job 🎀
  • -Z flag — the unstable, nightly-only flags for Cargo. Run cargo -Z help if you wanna see the whole menu of them ✨

💅 Miscellaneous Options 💅

  • -j N, --jobs N — how many parallel jobs you wanna run. You can also set this with the build.jobs config value <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults to the number of logical CPUs. If you give it a negative number, it sets the max number of parallel jobs to the number of logical CPUs plus the value you gave. If you hand it a string default, it sets the value back to the defaults. And babes — it should not be 0. Not ever. 🫶
  • --keep-going — build as many crates in the dependency graph as you possibly can, instead of straight up aborting the whole build the second one of them fails to build. It's giving resilience, it's giving perseverance 😤

So like, picture this: your current package depends on some dependencies — some of them fail, some of them work — and one of them fails to build. With cargo run -j1, Cargo may or may not build the one that succeeds (it all depends on which of the two builds Cargo decided to run first 🙈), whereas cargo run -j1 --keep-going would definitely run both builds, even if the one it ran first fails. No cap.

🌍 ENVIRONMENT 🌍

Cargo reads some environment variables, and the whole rundown lives in the reference <https://doc.rust-lang.org/cargo/reference/environment-variables.html>. Go peek for the details, bestie 💖

🚪 EXIT STATUS 🚪

  • 0: Cargo succeeded. Slay. 👑
  • 101: Cargo failed to complete. Not slay. 😭

🌸 EXAMPLES 🌸

  1. Build the local package and run its main target (this is assuming there's only one binary, okay?):
cargo run
  1. Run an example with extra arguments:
cargo run --example exname -- --exoption exarg1 exarg2

👀 SEE ALSO 👀

cargo(1), cargo-build(1)

And that's the whole page, bestie — you made it to the end, main character behaviour fr fr 🌈💜 This lil masterpiece comes to you from the CARGO-RUN(1) manual page, so go forth and cargo run something iconic. Periodt. ✨🎀

📦 where this page comes from