CARGO-GENERATE-LOCKFILE(1)

📦 version 1.82.0, in ubuntu jammy, ubuntu noble

✨ cargo-generate-lockfile(1) ✨

okay bestie, this one lives in the General Commands Manual section and it's about the moment your project gets its little lockfile glow-up 💅

🌸 NAME 🌸

cargo-generate-lockfile — Generate the lockfile for a package

🦋 SYNOPSIS 🦋

cargo generate-lockfile [options]

💖 DESCRIPTION 💖

So basically this command creates the Cargo.lock lockfile for the package or workspace you're standing in. Brand new file, fresh out the box ✨

But wait — if the lockfile is already there? Then it gets rebuilt with the latest available version of every package. It's giving "glow up era", not "keep things exactly as they were" 👑

Also see cargo-update(1), which can also create a Cargo.lock lockfile and has way more options for controlling how the update behaves. Sibling energy fr fr 🫶

🎀 OPTIONS 🎀

💅 Display Options

  • -v, --verbose — Use verbose output. You can drop this twice for "very verbose" output, which includes extra stuff like dependency warnings and build script output. It can also be set 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 set with the term.quiet config value (https://doc.rust-lang.org/cargo/reference/config.html).
  • --color when — Controls when colored output shows up. Valid values are:
    • auto (default): Automatically detects if color support is available on the terminal.
    • always: Always display colors. 🌈
    • never: Never display colors. 💀

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

🧚 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. not me ignoring the rules 🙈
  • --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 these scenarios happens:
    • The lock file is missing.
    • Cargo attempted to change the lock file due to a different dependency resolution.

It can be used in environments where deterministic builds are desired, such as in CI pipelines. periodt 🔒

  • --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 isn't 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 set 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 combo, iconic 🍓
  • --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).

👑 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.
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. slay 🎉
  • 101: Cargo failed to complete. 💀

🫶 EXAMPLES 🫶

  1. Create or update the lockfile for the current package or workspace:
cargo generate-lockfile

🌸 SEE ALSO 🌸

cargo(1), cargo-update(1)

and that's the whole page, bestie 💜 this one's filed under CARGO-GENERATE-LOCKFILE(1) in the General Commands Manual, and the footer is literally just the same name stamped at the bottom like a little signature — no cap, go forth and lock those deps ✨

📦 where this page comes from