Cargo 常用命令详解,认识 Cargo 的常用命令
一、项目管理相关
1. 创建项目
cargo new my_project
- 默认生成一个 二进制应用 项目。
- 加
--lib
创建 库项目:cargo new my_lib --lib
- 加
--vcs none
可以禁用 Git 初始化。
2. 初始化已有目录
cargo init
在一个已有目录中生成 Cargo.toml
和 src/main.rs
,适合把现有代码变成 Cargo 项目。
二、构建与运行
1. 构建
cargo build
- 默认编译到
target/debug/
。 - 发布模式:
cargo build --release
生成优化后的可执行文件,位置在
target/release/
。
2. 运行
cargo run
- 编译并运行
main.rs
。 - 可以附带参数:
cargo run -- arg1 arg2
3. 检查
cargo check
只做语法和类型检查,不生成二进制,速度更快,开发过程中常用。
三、依赖管理
1. 添加依赖
cargo add serde
cargo add tokio --features full
(需要安装 cargo-edit
扩展)
2. 更新依赖
cargo update
升级 Cargo.lock
中的依赖版本。
3. 查看依赖树
cargo tree
打印当前项目依赖关系,排查依赖冲突时非常有用。
四、测试与文档
1. 测试
cargo test
- 运行所有测试函数(带
#[test]
注解)。 - 过滤指定测试:
cargo test my_function
2. 文档
cargo doc --open
- 自动生成 HTML 格式的 API 文档并在浏览器中打开。
- Rust 社区提倡“文档即代码”,几乎所有 crate 都有文档。
五、发布与分发
1. 构建安装
cargo install --path .
把本地项目安装到 $HOME/.cargo/bin/
,方便全局调用。
2. 从 crates.io 安装
cargo install ripgrep
安装社区 crate 工具,相当于“Rust 世界的 npm install -g”。
3. 发布 crate
cargo login <API_TOKEN>
cargo publish
将项目上传到 crates.io。
六、工作区与工具命令
1. 工作区
[workspace]
members = ["core", "server", "cli"]
- 在根目录下运行:
cargo build
会一次性编译所有成员项目。
2. 格式化代码
cargo fmt
调用 rustfmt
统一代码风格。
3. 静态检查
cargo clippy
调用 clippy
做代码质量检查,给出优化建议。
七、命令速查表
命令 | 作用 |
---|---|
cargo new | 创建新项目 |
cargo init | 初始化已有目录为项目 |
cargo build | 构建项目 |
cargo run | 构建并运行 |
cargo check | 检查语法与类型 |
cargo test | 运行测试 |
cargo doc | 生成文档 |
cargo install | 安装可执行 crate |
cargo publish | 发布到 crates.io |
cargo update | 更新依赖 |
cargo tree | 查看依赖树 |
cargo fmt | 格式化代码 |
cargo clippy | 静态分析 |
THE END