17 unstable releases (4 breaking)
✓ Uses Rust 2018 edition
|0.5.0||Jan 19, 2020|
|0.4.2||Dec 5, 2019|
|0.4.1||Oct 28, 2019|
|0.3.3||Jun 20, 2019|
|0.1.0||Nov 21, 2015|
#4 in Cargo plugins
2,428 downloads per month
Used in 6 crates (5 directly)
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.
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.
Ensure that you have a fairly recent version of rust/cargo installed. On Ubuntu you would also need to install
$ cargo install cargo-edit
cargo's documentation to learn how
cargo install works and how to set up your system so it finds binaries installed by
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.
Add 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.
$ # Add a specific version $ cargo add firstname.lastname@example.org --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
$ cargo add --help Usage: cargo add <crate> [--dev|--build|--optional] [options] cargo add <crates>... [--dev|--build|--optional] [options] cargo add (-h|--help) cargo add --version Specify what crate to add: --vers <ver> Specify the version to grab from the registry (crates.io). You can also specify versions as part of the name, e.g `cargo add email@example.com`. --git <uri> Specify a git repository to download the crate from. This does not work if either a version or path (or both) is specified. --path <uri> Specify the path the crate should be loaded from. 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 <target> Add as dependency to the given target platform. This does not work for `dev-dependencies` or `build-dependencies`. Options: --rename=<alias> Rename the dependency to alias in Cargo.toml --sort Keep dependencies sorted --upgrade=<method> Choose method of semantic version upgrade. Must be one of "none" (exact version), "patch" (`~` modifier), "minor" (`^` modifier, default), or "all" (`>=`). --manifest-path=<path> Path to the manifest to add a dependency to. --allow-prerelease Include prerelease versions when fetching from crates.io (e.g. '0.6.0-alpha'). Defaults to false. -q --quiet Do not print any output in case of success. -h --help Show this help page. -V --version Show version. This command allows you to add a dependency to a Cargo.toml manifest file. If <crate> is a github or gitlab repository URL, or a local path, `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 "*").
Remove dependencies from your
$ # Remove a dependency $ cargo rm regex $ # Remove a development dependency $ cargo rm regex --dev $ # Remove a build dependency $ cargo rm regex --build
$ cargo rm --help Usage: cargo rm <crate> [--dev|--build] [options] cargo rm <crates>... [--dev|--build] [options] cargo rm (-h|--help) cargo rm --version Options: -D --dev Remove crate as development dependency. -B --build Remove crate as build dependency. --manifest-path=<path> Path to the manifest to remove a dependency from. -q --quiet Do not print any output in case of success. -h --help Show this help page. -V --version Show version. Remove a dependency from a Cargo.toml manifest file.
Upgrade 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,
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).
# Upgrade all dependencies for the current crate $ cargo upgrade # Upgrade docopt (to ~0.9) and serde (to >=0.9,<2.0) $ cargo upgrade docopt@~0.9 serde@>=0.9,<2.0 # Upgrade regex (to the latest version) across all crates in the workspace $ cargo upgrade regex --all
Upgrade dependencies as specified in the local manifest file (i.e. Cargo.toml). Usage: cargo upgrade [options] [<dependency>]... cargo upgrade (-h | --help) cargo upgrade (-V | --version) 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. `firstname.lastname@example.org`. 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.