This tool extends Cargo to allow you to add, remove, and upgrade dependencies by modifying your Cargo.toml file from the command line.
Currently available subcommands:
Thanks for your interest - we gratefully welcome contributions.
Questions can be asked in issues, or on Gitter.
To help us help you get pull requests merged quickly and smoothly, open an issue before submitted large changes. Please keep the contents of pull requests and commits short. Commit messages should include the intent of the commit.
cargo-edit has a moderately comprehensive test suite. Contributions that add/improve tests are awesome. Please add tests for every change.
cargo-edit uses rustfmt for formatting and clippy for linting.
Ensure that you have a fairly recent version of rust/cargo installed. On Ubuntu you would also need to install libssl-dev and pkg-config packages.
sh
$ cargo install cargo-edit
(Please check cargo's documentation to learn how cargo install works and how to set up your system so it finds binaries installed by cargo.)
Install a sub-set of the commands with cargo install -f --no-default-features --features "<COMMANDS>", where <COMMANDS> is a space-separated list of commands; i.e. add rm upgrade for the full set.
cargo addAdd new dependencies to your Cargo.toml. When no version is specified, cargo add will try to query the latest version's number from crates.io.
sh
$ # Add a specific version
$ cargo add regex@0.1.41 --dev
$ # Query the latest version from crates.io and adds it as build dependency
$ cargo add gcc --build
$ # Add a non-crates.io crate
$ cargo add local_experiment --path=lib/trial-and-error/
$ # Add a non-crates.io crate; the crate name will be found automatically
$ cargo add lib/trial-and-error/
$ # Add a crates.io crate with a local development path
$ cargo add my_helper --vers=1.3.1 --path=lib/my-helper/
$ # Add a renamed dependency
$ cargo add thiserror --rename error
```plain
$ cargo add --help
Usage:
cargo add
Specify what crate to add:
--vers cargo add bitflags@0.3.2.
--git
Specify where to add the crate:
-D --dev Add crate as development dependency.
-B --build Add crate as build dependency.
--optional Add as an optional dependency (for use in features). This does not work
for dev-dependencies or build-dependencies.
--target dev-dependencies or build-dependencies.
Options:
--rename=~ modifier), "minor"
(^ modifier, default), or "all" (>=).
--manifest-path=
This command allows you to add a dependency to a Cargo.toml manifest file. If cargo add will try to automatically get the crate name
and set the appropriate --git or --path value.
Please note that Cargo treats versions like "1.2.3" as "^1.2.3" (and that "^1.2.3" is specified
as ">=1.2.3 and <2.0.0"). By default, cargo add will use this format, as it is the one that the
crates.io registry suggests. One goal of cargo add is to prevent you from using wildcard
dependencies (version set to "*").
```
cargo rmRemove dependencies from your Cargo.toml.
sh
$ # Remove a dependency
$ cargo rm regex
$ # Remove a development dependency
$ cargo rm regex --dev
$ # Remove a build dependency
$ cargo rm regex --build
```plain
$ cargo rm --help
Usage:
cargo rm
Options:
-D --dev Remove crate as development dependency.
-B --build Remove crate as build dependency.
--manifest-path=
Remove a dependency from a Cargo.toml manifest file. ```
cargo upgradeUpgrade dependencies in your Cargo.toml to their latest versions.
To specify a version to upgrade to, provide the dependencies in the <crate name>@<version> format,
e.g. cargo upgrade docopt@~0.9.0 serde@>=0.9,<2.0.
This command differs from cargo update, which updates the dependency versions recorded in the
local lock file (Cargo.lock).
```sh
$ cargo upgrade
$ cargo upgrade docopt@~0.9 serde@>=0.9,<2.0
$ cargo upgrade regex --all ```
```plain Upgrade dependencies as specified in the local manifest file (i.e. Cargo.toml).
Usage:
cargo upgrade [options] [
Options: --all Upgrade all packages in the workspace. --manifest-path PATH Path to the manifest to upgrade. --allow-prerelease Include prerelease versions when fetching from crates.io (e.g. '0.6.0-alpha'). Defaults to false. --dry-run Print changes to be made without making them. Defaults to false. -h --help Show this help page. -V --version Show version.
This command differs from cargo update, which updates the dependency versions recorded in the
local lock file (Cargo.lock).
If <dependency>(s) are provided, only the specified dependencies will be upgraded. The version to
upgrade to for each can be specified with e.g. docopt@0.8.0.
Dev, build, and all target dependencies will also be upgraded. Only dependencies from crates.io are supported. Git/path dependencies will be ignored.
All packages in the workspace will be upgraded if the --all flag is supplied. The --all flag may
be supplied in the presence of a virtual manifest.
```
Apache-2.0/MIT