CARGO-FIX(1)

📦 version 1.85.1, in ubuntu jammy, ubuntu noble, ubuntu questing

💅 CARGO-FIX(1) — General Commands Manual 💅

hiii bestie 🫶 welcome to the cargo-fix page, straight outta the General Commands Manual. this is the one that makes rustc's little suggestions come true. buckle up, it's long, but we're getting through it together ✨

✨ NAME ✨

cargo-fix — Automatically fix lint warnings reported by rustc

🌸 SYNOPSIS 🌸

cargo fix [options]

🦋 DESCRIPTION 🦋

okay so here's the vibe: this Cargo subcommand takes rustc's suggestions — the ones that come bundled inside diagnostics like warnings — and automatically applies them to your source code. it's literally built to automate the stuff rustc was already telling you to go fix. the compiler already knew, it was just waiting for you to do it. not anymore 💅

when you run cargo fix, under the hood it executes cargo-check(1). any warnings that apply to your crate get fixed automatically (if that's possible), and every remaining warning shows up when the check process finishes. so like, if you wanna apply all the fixes to the current package, you just run:

cargo fix

which behaves the same as cargo check --all-targets. same energy, different name ✨

now, real talk: cargo fix is only capable of fixing code that's normally compiled with cargo check. so if some code is conditionally enabled with optional features, you gotta turn those features on for that code to even get analyzed:

cargo fix --features foo

same deal with other cfg expressions, like platform-specific code — you'll need to pass --target to fix code for that given target:

cargo fix --target x86_64-pc-windows-gnu

if you hit any problems with cargo fix, or you've got questions, or you wanna request a feature, please please please don't hesitate to file an issue at https://github.com/rust-lang/cargo 🫶

🎀 Edition migration 🎀

plot twist bestie, the cargo fix subcommand can also be used to migrate a package from one edition to the next (edition guide: https://doc.rust-lang.org/edition-guide/editions/transitioning-an-existing-project-to-a-new-edition.html). the general procedure is:

  1. Run cargo fix --edition. consider also using the --all-features flag if your project has multiple features. you may also want to run cargo fix --edition multiple times with different --target flags if your project has platform-specific code gated by cfg attributes.
  2. Modify Cargo.toml to set the edition field (docs: https://doc.rust-lang.org/cargo/reference/manifest.html#the-edition-field) to the new edition.
  3. Run your project tests to verify that everything still works. if new warnings get issued, you may wanna consider running cargo fix again (without the --edition flag) to apply any suggestions the compiler hands you.

and hopefully that's it!! 🎉 just keep in mind those caveats from above — cargo fix cannot update code for inactive features or cfg expressions. also, in some rare cases the compiler is unable to automatically migrate all code to the new edition, and that may require manual changes after building with the new edition. so like, eyes open, okay? 👀

🔥 OPTIONS 🔥

💜 Fix options 💜

  • --broken-code — fix code even if it already has compiler errors. this is useful if cargo fix fails to apply the changes. it'll apply the changes and leave the broken code sitting in the working directory for you to inspect and manually fix. (yes, it's called broken code. it knows. 🫣)
  • --edition — apply changes that will update the code to the next edition. this will not update the edition in the Cargo.toml manifest — that one has to be updated manually after cargo fix --edition has finished. no cap.
  • --edition-idioms — apply suggestions that will update code to the preferred style for the current edition.
  • --allow-no-vcs — fix code even if a VCS was not detected.
  • --allow-dirty — fix code even if the working directory has changes.
  • --allow-staged — fix code even if the working directory has staged changes.

🧚 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 --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 gets selected.

the default members of a workspace can be set explicitly with the workspace.default-members key in the root manifest. if that's 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.

  • -p *spec*…, --package *spec*… — fix 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. the shell is not your friend here bestie 😭
  • --workspace — fix all members in the workspace.
  • --all — deprecated alias for --workspace. it's giving legacy ✨
  • --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 fix will fix all targets (--all-targets implied). binaries are skipped if they have required-features that are missing.

passing target selection flags will fix only the specified targets.

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. (yes this warning is everywhere. it's important. iykyk.)

  • --lib — fix the package's library.
  • --bin *name*… — fix the specified binary. this flag may be specified multiple times and supports common Unix glob patterns.
  • --bins — fix all binary targets.
  • --example *name*… — fix the specified example. this flag may be specified multiple times and supports common Unix glob patterns.
  • --examples — fix all example targets.
  • --test *name*… — fix the specified integration test. this flag may be specified multiple times and supports common Unix glob patterns.
  • --tests — fix 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*… — fix the specified benchmark. this flag may be specified multiple times and supports common Unix glob patterns.
  • --benches — fix 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 — fix all targets. this is equivalent to specifying --lib --bins --tests --benches --examples. the full package, bestie, everything gets the treatment 👑

🍓 Feature Selection 🍓

the feature flags let you control which features are enabled. when no feature options are given, the default feature is activated for every selected package.

see the features documentation at 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 — fix for the given architecture. the default is the host architecture. the general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>. run rustc --print target-list for a list of supported targets. this flag may be specified multiple times.

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 documentation at https://doc.rust-lang.org/cargo/reference/build-cache.html for more details.

  • -r, --release — fix optimized artifacts with the release profile. see also the --profile option for choosing a specific profile by name.
  • --profile name — fix with the given profile.

as a special case, specifying the test profile will also enable checking in test mode, which will enable checking tests and enable the test cfg option. see rustc tests at https://doc.rust-lang.org/rustc/tests/index.html for more detail.

see the reference at 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 — okay so this turns on the yapping. Use it once for verbose output, and twice for “very verbose” output, which is the extra deluxe version that also shows stuff like dependency warnings and build script output. You can also set it with the term.verbose config value <https://doc.rust-lang.org/cargo/reference/config.html>. Bestie, it's giving “tell me everything” energy.
  • -q, --quiet — shhh 🤫 this tells Cargo not to 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 — controls when colored output is used. Valid values:
    • auto (default): Automatically detect if color support is available on the terminal. iykyk.
    • always: Always display colors. rainbow time 🌈.
    • never: Never display colors. no color, no drama. 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. So don't try to mix these, okay?
    • 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. Like it's looking for its emotional support manifest.
  • --ignore-rust-version — Ignore rust-version specification in packages. Not me ignoring my own boundaries, but okay.
  • --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. Very demure, very mindful, very reproducible. 💅
  • --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 <https://doc.rust-lang.org/cargo/reference/config.html>. So like, airplane mode but for builds ✈️.
  • --frozen — Equivalent to specifying both --locked and --offline. Two for one, slay.
  • --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 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 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>). So bestie, nightly only, okay? Don't try this on stable and then act surprised. 💀

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. Toolchain switch-up, main character energy.
  • --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. Config but make it spontaneous.
  • -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 <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>). Nightly gate again, bestie. Set the vibe before you pull up.
  • -h, --help — Prints help information. When in doubt, ask for help. It's giving healthy communication. 🫶
  • -Z flag — Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details. The forbidden knowledge corner 👑

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 provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. Zero jobs? Absolutely not, that's not a vibe.
  • --keep-going — Build 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 fix -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 fix -j1 --keep-going would definitely run both builds, even if the one run first fails. Keep going, keep glowing, don't let one flop stop the whole show. 🔥

ENVIRONMENT 🌈

See the reference <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for details on environment variables that Cargo reads. The tea is all there, bestie.

EXIT STATUS ✨

  • 0: Cargo succeeded. We love a win. 🎀
  • 101: Cargo failed to complete. Not the ending we wanted, but at least it's consistent. 😭

EXAMPLES 💅

  1. Apply compiler suggestions to the local package:
cargo fix
  1. Update a package to prepare it for the next edition:
cargo fix --edition
  1. Apply suggested idioms for the current edition:
cargo fix --edition-idioms

SEE ALSO 🦋

cargo(1), cargo-check(1)

And that's the tea from the CARGO-FIX(1) manual page footer — source/version: CARGO-FIX(1), date: not listed here, but the energy is eternal. 💖✨

📦 where this page comes from