cargo-add - Man Page

Add dependencies to a Cargo.toml manifest file

Examples (TL;DR)

Synopsis

cargo add [options] crate...
cargo add [options] --path path
cargo add [options] --git url [crate...]

Description

This command can add or modify dependencies.

The source for the dependency can be specified with:

If no source is specified, then a best effort will be made to select one, including:

When you add a package that is already present, the existing entry will be updated with the flags specified.

Upon successful invocation, the enabled (+) and disabled (-) features <https://doc.rust-lang.org/cargo/reference/features.md> of the specified dependency will be listed in the command's output.

Options

Source options

--git url

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

--branch branch

Branch to use when adding from git.

--tag tag

Tag to use when adding from git.

--rev sha

Specific commit to use when adding from git.

--path path

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

--registry registry

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.

Section options

--dev

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

--build

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

--target target

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

</dl>

Dependency options

--dry-run

Don't actually write the manifest

--rename name

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

--optional

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

--no-optional

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

--no-default-features

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

--default-features

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

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

Display Options

-v,  --verbose

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

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

--color when

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

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.

-p spec,  --package spec

Add dependencies to only the specified package.

--frozen,  --locked

Either of these flags requires that the Cargo.lock file is up-to-date. If the lock file is missing, or it needs to be updated, Cargo will exit with an error. The --frozen flag also prevents Cargo from attempting to access the network to determine if it is out-of-date.

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

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

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.

-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

Examples

 1. Add regex as a dependency

cargo add regex

 2. Add trybuild as a dev-dependency

cargo add --dev trybuild

 3. Add an older version of nom as a dependency

cargo add nom@5

 4. Add support for serializing data structures to json with derives

cargo add serde serde_json -F serde/derive

See Also

cargo(1), cargo-remove(1)

Referenced By

cargo-remove(1).