Cargo 常用命令速查手册
本文档整理了 Rust 包管理工具 Cargo 的核心命令,涵盖项目创建、依赖管理、构建运行、发布等场景,适合 Rust 开发者快速查阅。
一、项目创建与初始化
1. 创建新项目
创建可执行项目(binary)
cargo new my-project创建库项目(library)
cargo new --lib my-lib2. 初始化现有目录
将现有目录初始化为 Cargo 项目
cargo init初始化为库项目
cargo init --lib二、依赖管理
1. 添加依赖
添加最新版本依赖到 Cargo.toml
cargo add serde添加指定版本依赖
cargo add serde@1.0.150添加开发依赖(dev-dependencies)
cargo add --dev tokio-test添加构建依赖(build-dependencies)
cargo add --build cc从 Git 仓库添加依赖
cargo add --git https://github.com/serde-rs/serde.git serde添加带特性的依赖
cargo add serde --features "derive"2. 移除依赖
从 Cargo.toml 移除依赖
cargo remove serde移除开发依赖
cargo remove --dev tokio-test3. 更新依赖
更新 Cargo.lock 锁定的依赖到最新兼容版本
cargo update更新指定包
cargo update -p serde三、构建与运行
1. 构建项目
Debug 模式构建(默认)
cargo buildRelease 模式构建(优化编译)
cargo build --release仅检查代码,不构建
cargo check2. 运行项目
运行开发版本
cargo run运行 Release 版本
cargo run --release传递参数运行
cargo run -- --help四、测试与文档
1. 运行测试
运行所有测试
cargo test运行指定测试函数
cargo test test_name运行测试并显示输出
cargo test -- --show-output运行单个文件中的测试
cargo test --lib path::to::module并行运行测试(默认)
cargo test --test-threads=4串行运行测试
cargo test --test-threads=12. 文档生成
生成并打开文档
cargo doc --open生成文档(不打开)
cargo doc包含私有项的文档
cargo doc --document-private-items检查文档中的示例代码
cargo test --doc五、发布与清理
1. 打包发布
准备发布(检查可发布性)
cargo publish --dry-run发布到 crates.io
cargo publish2. 清理缓存
清理 Debug 构建产物
cargo clean清理 Release 构建产物
cargo clean --release清理指定 target
cargo clean --target-dir my-target六、工作空间(Workspace)
1. 创建工作空间
创建工作空间
cargo new my-workspace2. 在工作空间中添加成员
在 Cargo.toml 中配置
[workspace]
members = ["member1", "member2", "member3"]七、检查与分析
1. 代码检查
运行 Clippy(Rust linter)
cargo clippyClippy 并自动修复警告
cargo clippy --fix检查指定目标
cargo clippy --bin my-bin2. 代码格式化
格式化代码
cargo fmt检查格式化问题
cargo fmt --check3. 其他检查
检查未使用的依赖
cargo udeps生成构建统计信息
cargo build --timings八、环境变量与配置
1. 设置环境变量
运行时设置环境变量
RUST_LOG=debug cargo run设置多个环境变量
RUST_LOG=debug DATABASE_URL=postgres://localhost/db cargo run2. 配置 Cargo
配置默认工具链
rustup default stable查看当前配置
cargo config get build.target九、高级命令
1. 安装二进制工具
从 crates.io 安装工具
cargo install ripgrep从 Git 仓库安装
cargo install --git https://github.com/BurntSushi/ripgrep ripgrep列出已安装的工具
cargo install --list卸载工具
cargo uninstall ripgrep2. 扩展命令
使用第三方 cargo 命令
cargo install cargo-edit
cargo add dependency3. 交叉编译
编译为其他平台
cargo build --target x86_64-unknown-linux-musl查看所有可用 target
rustup target list添加 target
rustup target add x86_64-unknown-linux-musl十、调试与排错
1. 查看依赖树
查看依赖关系
cargo tree查看反向依赖
cargo tree --invert查看指定包的依赖
cargo tree -p serde2. 查看包信息
查看包详细信息
cargo package查看包内容(不打包)
cargo package --allow-dirty3. 验证项目
验证Cargo.toml 和 Cargo.lock
cargo verify-project十一、常用别名
可以通过 .cargo/config.toml 配置命令别名
[alias]
b = "build"
r = "run"
t = "test"
c = "check"
br = "build --release"
rr = "run --release"使用示例
cargo br
cargo rr十二、性能优化
1. 并行编译
使用多核编译
CARGO_BUILD_JOBS=4 cargo build2. 增量编译
启用增量编译(默认已启用)
CARGO_INCREMENTAL=1 cargo build3. 链接优化
使用 lld 链接器(更快)
cargo build --release在 .cargo/config.toml 中配置
[target.x86_64-unknown-linux-gnu]
linker = "clang"
rustflags = ["-C", "link-arg=-fuse-ld=lld"]十三、实用技巧
1. 查看命令帮助
查看所有可用命令
cargo --help查看具体命令帮助
cargo build --help2. 查看版本信息
查看 Cargo 版本
cargo --version查看 Rust 版本
rustc --version查看 Rust 工具链信息
rustup show3. 项目信息
显示项目元数据
cargo metadata --format-version 14. 快速搜索包
在 crates.io 搜索包
cargo search serde按描述搜索
cargo search "http client"十四、工作流程示例
1. 典型开发流程
# 创建项目
cargo new my-app
cd my-app
# 添加依赖
cargo add tokio --features full
# 编写代码后
cargo check
cargo test
# 运行开发版本
cargo run
# 发布前检查
cargo clippy
cargo fmt --check
# Release 构建
cargo build --release
# 发布到 crates.io
cargo publish2. 调试流程
# 开发模式运行
cargo run
# 设置日志级别
RUST_LOG=debug cargo run
# 运行测试
cargo test
# 检查代码
cargo clippy
# 分析编译时间
cargo build --timings