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.
console,ignore
$ cargo install cargo-edit
If you wish to use a bundled version of openssl:
console,ignore
$ cargo install cargo-edit --features vendored-openssl
Compiler support: requires rustc 1.44+
(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.
console,ignore
$ # 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
```console $ cargo-add add -h cargo-add [..] Add dependencies to a Cargo.toml manifest file
USAGE:
cargo add [OPTIONS]
ARGS:
OPTIONS:
--no-default-features Disable the default features
--default-features Re-enable the default features
-F, --features Cargo.toml
-p, --package
SECTION:
-D, --dev Add as development dependency
-B, --build Add as build dependency
--target
UNSTABLE:
-Z
Examples: $ cargo add regex --build $ cargo add trycmd --dev $ cargo add ./crate/parser/ $ cargo add serde +derive serde_json
```
cargo rmRemove dependencies from your Cargo.toml.
console,ignore
$ # Remove a dependency
$ cargo rm regex
$ # Remove a development dependency
$ cargo rm regex --dev
$ # Remove a build dependency
$ cargo rm regex --build
```console $ cargo-rm rm --help cargo-rm [..] Remove a dependency from a Cargo.toml manifest file
USAGE:
cargo rm [OPTIONS]
ARGS:
OPTIONS:
-B, --build Remove crate as build dependency
-D, --dev Remove crate as development dependency
-h, --help Print help information
--manifest-path
```
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).
```console,ignore
$ cargo upgrade
$ cargo upgrade docopt@~0.9 serde@>=0.9,<2.0
$ cargo upgrade regex --workspace
$ cargo upgrade --exclude docopt serde ```
```console $ cargo-upgrade upgrade --help cargo-upgrade [..] Upgrade dependencies as specified in the local manifest file (i.e. Cargo.toml)
USAGE: cargo upgrade [OPTIONS] [DEPENDENCY]...
ARGS:
OPTIONS:
--all [deprecated in favor of --workspace]
--allow-prerelease Include prerelease versions when fetching from crates.io (e.g.
0.6.0-alpha')
--dry-run Print changes to be made without making them
--exclude
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 or serde@>=0.9,<2.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 --workspace flag is supplied. The
--workspace flag may be supplied in the presence of a virtual manifest.
If the '--to-lockfile' flag is supplied, all dependencies will be upgraded to the currently locked version as recorded in the Cargo.lock file. This flag requires that the Cargo.lock file is up-to- date. If the lock file is missing, or it needs to be updated, cargo-upgrade will exit with an error. If the '--to-lockfile' flag is supplied then the network won't be accessed.
```
cargo set-versionSet the version in your Cargo.toml.
```console,ignore
$ cargo set-version 1.0.0
$ cargo set-version --bump major
$ cargo set-version --bump minor
$ cargo set-version --bump patch ```
```console $ cargo-set-version set-version --help cargo-set-version [..] Change a package's version in the local manifest file (i.e. Cargo.toml)
USAGE: cargo set-version [OPTIONS] [TARGET]
ARGS:
OPTIONS:
--all [deprecated in favor of --workspace]
--bump
```
For more on metadata, see the
semver crate's documentation.
Apache-2.0/MIT