CARGO-GENERATE-LOCKFILE(1)

CARGO-GENERATE-LOCKFILE(1) 💖

okay bestie, this is a page from the General Commands Manual — the whole cargo-generate-lockfile situation. let's get into it, no cap.

---

✨ 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 your current package or workspace. that's it, that's the job. ✨

and if the lockfile is already there? it gets rebuilt with the latest available version of every single package. so it's giving "glow up" energy, not "start from scratch" energy. 💅

also, lowkey important: go look at cargo-update(1) too, bestie. it can also create a Cargo.lock lockfile, and it has way more options for controlling the update behavior. so if you need finer control, that's your girl. 👑

---

💅 OPTIONS 💅

💖 Display Options 💖

• -v, --verbose — use verbose output. and yes, you can specify it twice for "very verbose" output, which includes extra stuff like dependency warnings and build script output. can also be set with the term.verbose config value <https://doc.rust-lang.org/cargo/reference/config.html>. (two v's is the move, fr fr)
• -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>. shhh 🤫
• --color when — controls when colored output is used. valid values are:
  • 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>.

🎀 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. it's giving "I'll find it myself" energy. 🕵️
• --ignore-rust-version — ignore rust-version specification in packages. not me pretending that constraint doesn't exist 🙈
• --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. this is the "no surprises, periodt" flag. 👑

• --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 flags in one trench coat. 🧥✨

🌈 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. stack 'em up 💅
• -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>). so like, don't come crying to me on stable, okay? 😭

• -h, --help — prints help information. the classic. 🫶
• -Z flag — unstable (nightly-only) flags to Cargo. run cargo -Z help for details. living on the edge, I see. 🔥

---

🧚 ENVIRONMENT 🧚

see the reference <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for details on environment variables that Cargo reads. yes, cargo is nosy. it reads things. go look. 👀

---

⭐ EXIT STATUS ⭐

• 0: Cargo succeeded. 🎉 slay!!
• 101: Cargo failed to complete. 💀 rip

---

🍓 EXAMPLES 🍓

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

cargo generate-lockfile

that's it. one line. iconic. ✨

---

👑 SEE ALSO 👑

cargo(1), cargo-update(1)

---

and that's the whole page, bestie!! this was CARGO-GENERATE-LOCKFILE(1) from the General Commands Manual — mwah, go generate that lockfile, you got this 💖🦋✨