Cheat Sheet logoCheat Sheet Today

Rust CLI Package, Install, Publish, and Release

Rust CLI•Permalink

Package local crates, install binaries, publish to crates.io, and prepare Rust CLI releases.

Sign in to save
View
StandardDetailedCompact
Export
Copy the compact sheet, download it, or print it.
Download
`D` dense toggle · `C` copy all

Local packaging

Prepare release artifacts and inspect package contents.

Create a package tarball

Build the package as it would be published.

↗#
bashANYcargopackage
bash
cargo package

Validates and assembles the publishable package locally.

List packaged files

Show what files would go into the package.

↗#
bashANYcargopackagefiles
bash
cargo package --list

Useful for catching missing files or extra junk before publishing.

Validate publish without uploading

Run all publish checks without actually publishing.

↗#
bashANYcargopublishdry-run
bash
cargo publish --dry-run

A safer preflight step before a real crates.io publish.

Clean before a release build

Rebuild from a clean state for reproducibility.

↗#
bashANYcargoreleaseclean
bash
cargo clean && cargo build --release

Helps surface missing tracked files or stale artifacts before release.

Install binary crates

Install tools from crates.io, git, local paths, or locked dependencies.

Install a binary from crates.io

Install a published executable crate.

↗#
bashANYcargoinstallcrates-io
bash
cargo install ripgrep

`cargo install` manages Cargo's local set of installed binary crates.

Install a specific version

Pin the crate version during install.

↗#
bashANYcargoinstallversion
bash
cargo install ripgrep --version 14.1.0

Useful for reproducibility in local developer setups.

Honor the package lockfile

Use the package's lockfile when installing.

↗#
bashANYcargoinstalllocked
bash
cargo install --locked ripgrep

Common when you want installation to match the published lockfile.

Install from a local path

Build and install the current local crate.

↗#
bashANYcargoinstallpath
bash
cargo install --path .

Great for trying your CLI exactly as users would invoke it.

Install directly from git

Build and install a binary crate from a repository.

↗#
bashANYcargoinstallgit
bash
cargo install --git https://github.com/sharkdp/bat

Useful for unreleased versions or internal tools.

Remove an installed binary crate

Delete binaries installed by `cargo install`.

↗#
bashANYcargouninstall
bash
cargo uninstall ripgrep

Cleans up tools from Cargo's install root.

Publish to crates.io

Authentication, publishing, and registry-related tasks.

Save a crates.io API token

Authenticate Cargo for publishing.

↗#
bashANYcargologincrates-io
bash
cargo login <token>

Stores the token so Cargo can publish to the registry.

Manage crate owners

Add a user or team as a crate owner.

↗#
bashANYcargoownercrates-io
bash
cargo owner --add github:org:team mycrate

Useful for shared maintenance of published crates.

Publish the crate

Upload the local package to the configured registry.

↗#
bashANYcargopublish
bash
cargo publish

The default registry is crates.io unless another registry is specified.

Search crates.io from the CLI

Find crate names and summaries.

↗#
bashANYcargosearchcrates-io
bash
cargo search clap

A quick way to discover package names before adding dependencies.

Yank a published version

Prevent new dependency resolution to a release.

↗#
bashANYcargoyankcrates-io
bash
cargo yank --vers 1.2.3 mycrate

Yanking hides a release from new resolution without deleting it.

Release recipes

Practical release commands for Rust CLI apps.

Build an optimized release binary

Compile the release artifact for shipping.

↗#
bashANYcargoreleasebinary
bash
cargo build --release

The default production build path for many CLI apps.

Build a mostly static Linux binary

Compile against the musl target.

↗#
bashANYcargoreleasemusl
bash
cargo build --release --target x86_64-unknown-linux-musl

Common for distributing portable Linux executables.

Read current package version

Inspect the manifest version before tagging a release.

↗#
bashANYcargoreleaseversion
bash
cargo pkgid

Handy when scripting release steps, though tags are usually managed separately.

More in Rust CLI

Rust CLI Troubleshooting: CI, Environment, Build Scripts, and Publishing
Commands for debugging CI failures, environment mismatches, build script output, installation problems, and publish checks in Rust CLI projects.
Rust CLI Troubleshooting: rustup, Toolchains, Components, and Targets
Commands for fixing toolchain mismatches, missing components, and cross-compilation target issues in Rust CLI projects.
Rust CLI Troubleshooting: Tests, Doctests, and Documentation
Commands for debugging failing tests, capturing output, isolating flaky cases, and fixing documentation-generation issues in Rust CLI projects.
Rust CLI Troubleshooting: Dependencies, Features, and Lockfiles
Commands for analyzing dependency trees, feature activation, duplicate crates, and lockfile behavior in Rust CLI projects.
Rust CLI Troubleshooting: Manifest, Packages, and Workspaces
Commands and examples for debugging Cargo.toml issues, package selection mistakes, and workspace confusion in Rust CLI repos.
Rust CLI Troubleshooting: Build Errors and Diagnostics
Commands for investigating compiler errors, Cargo diagnostics, verbose output, and fix suggestions in Rust CLI projects.

Recommended next

No recommendations yet.
Browse all sheets →