This tool extends Cargo to allow you to add and list dependencies by reading/writing to your Cargo.toml
file from the command line.
Currently available subcommands:
If you have a recent version of cargo
, you can use cargo install
to get all the tools provided by cargo-edit
in one simple step:
$ 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
.)
You can build all commands of cargo-edit
from the source available on GitHub:
$ git clone https://github.com/killercup/cargo-edit.git
$ cd cargo-edit
$ cargo build --release
Once you have the executables, you can move them to a directory in your $PATH
, e.g.
$ cp target/release/cargo-* ~/.bin/
You should be able to use the new Cargo subcommands now.
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 [email protected] --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/
$ # Also
$ cargo add lib/trial-and-error/
$ cargo add --help
Usage:
cargo add <crate> [--dev|--build|--optional] [--ver=<semver>|--git=<uri>|--path=<uri>] [options]
cargo add (-h|--help)
cargo add --version
Options:
-D --dev Add crate as development dependency.
-B --build Add crate as build dependency.
--ver=<semver> 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 protected]`.
--git=<uri> Specify a git repository to download the crate from.
--path=<uri> Specify the path the crate should be loaded from.
--optional Add as an optional dependency (for use in features.)
--manifest-path=<path> Path to the manifest to add a dependency to.
-h --help Show this help page.
--version Show version.
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.
$ cargo list
clippy 0.0.19
docopt 0.6
pad 0.1
rustc-serialize 0.3
semver 0.1
toml 0.1
$ cargo list --tree
├── assert_cli (0.1.0)
│ ├── ansi_term (0.6.3)
│ └── difference (0.4.1)
│ └── getopts (0.2.14)
├── clippy (0.0.19)
│ └── unicode-normalization (0.1.1)
├── docopt (0.6.73)
│ ├── regex (0.1.41)
│ │ ├── aho-corasick (0.3.2)
│ │ │ └── memchr (0.1.6)
│ │ │ └── libc (0.1.10)
│ │ ├── memchr (0.1.6)
│ │ │ └── libc (0.1.10)
│ │ └── regex-syntax (0.2.2)
│ ├── rustc-serialize (0.3.16)
│ └── strsim (0.3.0)
├── pad (0.1.4)
│ └── unicode-width (0.1.3)
├── rustc-serialize (0.3.16)
├── semver (0.1.20)
└── toml (0.1.23)
└── rustc-serialize (0.3.16)
$ cargo list --help
Usage:
cargo list [<section>] [options]
cargo list (-h|--help)
cargo list --version
Options:
--manifest-path=<path> Path to the manifest to add a dependency to.
--tree List dependencies recursively as tree.
-h --help Show this help page.
Display a crate's dependencies using its Cargo.toml file.
Remove dependencies from your Cargo.toml
.
$ cargo rm regex
$ cargo rm regex --dev
$ cargo rm regex --build
$ cargo rm --help
Usage:
cargo rm <crate> [--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.
-h --help Show this help page.
--version Show version.
Remove a dependency to a Cargo.toml manifest file.
Apache-2.0/MIT