CheatPress

Cargo Rust package manager

Version 1.99 · source

Cargo, Postcard, light preview Light · Postcard 102 × 152 mm · PDF Cargo, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF Cargo, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
Cargo, A5, light preview Light · A5 148 × 210 mm · PDF Cargo, A5, dark preview Dark · A5 148 × 210 mm · PDF Cargo, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
Cargo, A4, light preview Light · A4 210 × 297 mm · PDF Cargo, A4, dark preview Dark · A4 210 × 297 mm · PDF Cargo, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
Cargo, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF Cargo, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF Cargo, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
Cargo, A3, light preview Light · A3 297 × 420 mm · PDF Cargo, A3, dark preview Dark · A3 297 × 420 mm · PDF Cargo, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
Cargo, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF Cargo, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF Cargo, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
Cargo, Letter, light preview Light · Letter 8.5 × 11 in · PDF Cargo, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF Cargo, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
Cargo, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF Cargo, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF Cargo, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

cargo new <name>
Create a project
cargo run
Build and run
cargo check
Type-check fast
cargo test
Run all tests
cargo add <crate>
Add a dependency
cargo build --release
Optimised build
cargo fmt
Format the code
cargo clippy
Lint the code

Concepts

Workspace root Cargo.toml, Cargo.lock, target/
Package one Cargo.toml, a crate or more
Target lib, bin, example, test, bench
A workspace shares one Cargo.lock and one target/ directory

Projects

cargo new <name>
Create a binary package
Add --lib for a library.
cargo init
Make the current directory a package
cargo run
Build and run the binary
Program arguments go after --.
cargo run --bin <name>
Run a specific binary
cargo run --example <name>
Run an example
cargo clean
Delete the target directory
cargo doc --open
Build docs and open them
Add --no-deps to skip dependency docs.
cargo install <crate>
Install a binary crate
Lands in ~/.cargo/bin by default.
cargo install --path .
Install the local package
cargo uninstall <crate>
Remove an installed binary

Build & check

cargo build
Compile in the dev profile
cargo build --release
Compile with optimisations
Output goes to target/release/.
cargo check
Type-check without building
cargo check --all-targets
Also check tests and examples
cargo build --target <triple>
Cross-compile
The target's std must be installed first.
cargo build --timings
HTML report of build times
cargo fetch
Download dependencies only
cargo fix
Apply compiler-suggested fixes
Refuses on a dirty tree unless --allow-dirty.

Test & lint

cargo test
Run unit, integration and doc tests
cargo test <filter>
Run tests whose name contains text
cargo test -- --nocapture
Show output of passing tests
cargo test --lib
Unit tests only
cargo test --doc
Doc tests only
cargo test --test <name>
One integration test file
cargo test --no-fail-fast
Keep going after a failure
By default Cargo stops after the first failing test binary.
cargo test -- --exact <path>
Match the full test name
cargo test -- --test-threads=1
Run tests serially
cargo test --no-run
Compile tests without running
cargo bench
Run benchmarks
cargo fmt
Format with rustfmt
cargo fmt --check
Fail if code is unformatted
cargo clippy
Lint with Clippy
cargo clippy -- -D warnings
Treat lints as errors

Dependencies

cargo add <crate>
Add a dependency
cargo add <crate>@<ver>
Add with a version requirement
cargo add --dev <crate>
Add a dev-dependency
cargo add <crate> -F <feat>
Add with a feature enabled
cargo add --dry-run <crate>
Preview the manifest change
cargo remove <crate>
Remove a dependency
cargo update
Update Cargo.lock within semver
cargo update <crate>
Update only one crate
cargo update <crate> --precise <ver>
Pin a crate to a version
cargo tree
Show the dependency tree
cargo tree -i <crate>
Who depends on this crate?
cargo tree -d
Show duplicate versions
cargo tree -e features -i <crate>
Why is a feature enabled?
cargo search <term>
Search crates.io
cargo metadata --format-version 1
Package info as JSON

Features

cargo build --features <list>
Enable features
Comma- or space-separated; quote a space-separated list.
cargo build --no-default-features
Turn off the default feature set
cargo build --all-features
Enable every feature
cargo build -F <pkg>/<feat>
Enable a feature of a member
Cargo.toml features
[features]default = ["json"]json = ["dep:serde_json"]fast = [][dependencies]serde_json = { version = "1", optional = true }

Profiles

dev vs release defaults
Setting dev release
opt-level 0 3
debug true false
debug-assertions true false
overflow-checks true false
incremental true false
cargo build --profile <name>
Build with a custom profile
Output goes to target/<name>/.
Release tuning
[profile.release]lto = truecodegen-units = 1panic = "abort"strip = "symbols"[profile.release-debug]inherits = "release"debug = true

Workspaces

cargo build --workspace
Build every member
cargo test -p <pkg>
Test one package
cargo build -p <pkg>
Build one package
cargo test --workspace --exclude <pkg>
All members except one
cargo run -p <pkg>
Run a member's binary
Root Cargo.toml
[workspace]members = ["crates/*"]resolver = "3"[workspace.dependencies]serde = "1"
Member Cargo.toml
[dependencies]serde = { workspace = true }

Publishing

cargo login
Store a registry token
cargo package --list
Show files that would be packaged
cargo publish --dry-run
Run all checks, upload nothing
cargo publish
Upload to crates.io
Published versions cannot be deleted, only yanked.
cargo publish -p <pkg>
Publish one workspace member
cargo yank <version>
Block new users of a version
Existing lockfiles keep working.
cargo owner --add <user>
Add a crate owner

Recipes

New project to first run
cargo new hello && cd hellocargo add clap -F derivecargo run
CI gate
cargo fmt --checkcargo clippy --all-targets -- -D warningscargo test --workspace --locked
Why is this crate built twice?
cargo tree -dcargo tree -i <crate>@<ver>
Release a crate
cargo testcargo publish --dry-rungit tag v<ver> && cargo publish

Help

cargo help <command>
Manual for a command
cargo <command> -h
Short usage summary
cargo --list
List installed subcommands