cargo-add - Man Page

Git URL to add the specified crate from <https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories>.

Branch to use when adding from git.

Tag to use when adding from git.

Specific commit to use when adding from git.

Filesystem path <https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies> to local crate to add.

Name of the registry to use. Registry names are defined in Cargo config files <https://doc.rust-lang.org/cargo/reference/config.html>. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to crates-io.

Add as a development dependency <https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#development-dependencies>.

Add as a build dependency <https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#build-dependencies>.

Add as a dependency to the given target platform <https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#platform-specific-dependencies>.

To avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.

Don’t actually write the manifest

Rename <https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#renaming-dependencies-in-cargotoml> the dependency.

Mark the dependency as optional <https://doc.rust-lang.org/cargo/reference/features.html#optional-dependencies>.

Mark the dependency as required <https://doc.rust-lang.org/cargo/reference/features.html#optional-dependencies>.

Mark the dependency as public.

The dependency can be referenced in your library’s public API.

Unstable (nightly-only) <https://doc.rust-lang.org/cargo/reference/unstable.html#public-dependency>

Mark the dependency as private.

While you can use the crate in your implementation, it cannot be referenced in your public API.

Unstable (nightly-only) <https://doc.rust-lang.org/cargo/reference/unstable.html#public-dependency>

Disable the default features <https://doc.rust-lang.org/cargo/reference/features.html#dependency-features>.

Re-enable the default features <https://doc.rust-lang.org/cargo/reference/features.html#dependency-features>.

Space or comma separated list of features to activate <https://doc.rust-lang.org/cargo/reference/features.html#dependency-features>. When adding multiple crates, the features for a specific crate may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

Use verbose output. May be specified twice for “very verbose” output which includes extra output such as dependency warnings and build script output. May also be specified with the term.verbose config value <https://doc.rust-lang.org/cargo/reference/config.html>.

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>.

Control when colored output is used. Valid values:

• 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>.

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

Add dependencies to only the specified package.

Ignore rust-version specification in packages.

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.

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>.

Equivalent to specifying both --locked and --offline.

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.

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.

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>).

Prints help information.

Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.