cargo generate-lockfile

NAME

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

SYNOPSIS

cargo generate-lockfile [OPTIONS]

DESCRIPTION

This command will create the Cargo.lock lockfile for the current package orworkspace. If the lockfile already exists, it will be rebuilt if there are anymanifest changes or dependency updates.

See also cargo-update(1) which is also capable of creating a Cargo.locklockfile and has more options for controlling update behavior.

OPTIONS

Display Options

  • -v
  • —verbose

  • Use verbose output. May be specified twice for "very verbose" output whichincludes extra output such as dependency warnings and build script output.May also be specified with the term.verboseconfig value.

  • -q

  • —quiet

  • No output printed to stdout.

  • —colorWHEN

  • Control when colored output is used. Valid values:

  • auto (default): Automatically detect if color support is available on theterminal.

  • always: Always display colors.

  • never: Never display colors.

May also be specified with the term.colorconfig value.

Manifest Options

  • —manifest-pathPATH

  • Path to the Cargo.toml file. By default, Cargo searches in the currentdirectory or any parent directory for the Cargo.toml file.

  • —frozen

  • —locked
  • Either of these flags requires that the Cargo.lock file isup-to-date. If the lock file is missing, or it needs to be updated, Cargo willexit with an error. The —frozen flag also prevents Cargo fromattempting to access the network to determine if it is out-of-date.

These may be used in environments where you want to assert that theCargo.lock file is up-to-date (such as a CI build) or want to avoid networkaccess.

  • —offline
  • Prevents Cargo from accessing the network for any reason. Without thisflag, Cargo will stop with an error if it needs to access the network andthe network is not available. With this flag, Cargo will attempt toproceed without the network if possible.

Beware that this may result in different dependency resolution than onlinemode. Cargo will restrict itself to crates that are downloaded locally, evenif 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 goingoffline.

May also be specified with the net.offline config value.

Common Options

  • -h
  • —help

  • Prints help information.

  • -ZFLAG…​

  • Unstable (nightly-only) flags to Cargo. Run cargo -Z help fordetails.

ENVIRONMENT

See the reference fordetails on environment variables that Cargo reads.

Exit Status

  • 0

  • Cargo succeeded.

  • 101

  • Cargo failed to complete.

EXAMPLES

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

SEE ALSO

cargo(1), cargo-update(1)