CARGO-GENERATE-LOCKFILE(1)

💅 NAME 💅

cargo-generate-lockfile — bestie, this one generates the lockfile for a package. That's it. That's the job. 🎀

---

✨ SYNOPSIS ✨

cargo generate-lockfile [options]

---

🦋 DESCRIPTION 🦋

okay so picture this: you run this command and it creates the Cargo.lock lockfile for whatever package or workspace you're standing in. 💖

And if the lockfile is already there? Not me being lazy — it gets rebuilt with the latest available version of every package. Glow up, lockfile edition. ✨

Also also also — go look at cargo-update(1). That one can make a Cargo.lock lockfile too, and it's got more options for controlling update behavior. So if you need finer control, that's your girl. 👑

---

🌈 OPTIONS 🌈

💖 Display Options 💖

• -v, --verbose — verbose output, periodt. Say it twice and you get "very verbose" output, which is giving extra stuff like dependency warnings and build script output. You can also set this with the term.verbose config value: https://doc.rust-lang.org/cargo/reference/config.html.
• -q, --quiet — do not print cargo log messages. silence, iconic, no notes. 🫶 Can also be set with the term.quiet config value: https://doc.rust-lang.org/cargo/reference/config.html.
• --color when — controls when colored output gets used. Valid values, bestie:
  • auto (default): automatically detect if color support is available on the terminal. lowkey smart of it.
  • always: always display colors. 🌈 slay.
  • never: never display colors.

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

🌸 Manifest Options 🌸

• --manifest-path path — the path to the Cargo.toml file. By default, Cargo goes hunting for Cargo.toml in the current directory or any parent directory. it's giving detective energy. 🔍
• --ignore-rust-version — ignore the rust-version specification in packages. pretend you didn't see it. 🙈
• --publish-time yyyy-mm-ddThh:mm:ssZ — latest publish time allowed for registry packages (Unstable). ⚠️

This is a best-effort filter on allowed packages, including:

• packages from unsupported registries are always accepted
• only the current yank state is respected, not the state as of --publish-time
• precision of the publish time

• --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 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. main character CI behavior fr fr.

• --offline — prevents Cargo from accessing the network for any reason. Without this flag, Cargo stops with an error if it needs the network and the network isn't there. 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 at the same time. two-for-one, we love a bundle. 🎀

💜 Common Options 💜

• +toolchain — if Cargo has been installed with rustup, and the first argument to cargo begins with +, it gets interpreted as a rustup toolchain name (like +stable or +nightly). See the rustup documentation for more info on how toolchain overrides work: https://rust-lang.github.io/rustup/overrides.html.
• --config KEY=VALUE or PATH — overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or given as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more: https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides.
• -C PATH — changes the current working directory before executing any specified operations. This affects stuff like where cargo looks by default for the project manifest (Cargo.toml), and also the directories searched for discovering .cargo/config.toml, for example. This option must appear before the command name, like cargo -C path/to/my-project build.

This option is only available on the nightly channel and requires the -Z unstable-options flag to enable (see #10098: https://github.com/rust-lang/cargo/issues/10098). 🧚✨

• -h, --help — prints help information. our hero. 🫶
• -Z flag — unstable (nightly-only) flags to Cargo. Run cargo -Z help for details. iykyk. 👑

---

🌱 ENVIRONMENT 🌱

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

---

⭐ EXIT STATUS ⭐

• 0: Cargo succeeded. 🎉
• 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, no cap 💖 this was CARGO-GENERATE-LOCKFILE(1) from the General Commands Manual, signing off — go forth and lock those files, you absolute icon 🎀✨🦋