Knots

Appearance

以下是 Cargo（Rust 包管理器）的主要命令列表，包含常用命令及其功能说明：

基础项目管理 ​

  • cargo new <project-name>
    新建项目（会创建新文件夹，可带 --bin 或 --lib 指定类型）。

  • cargo init 在当前文件夹初始化项目

  • cargo build
    编译调试版本（输出到 target/debug/）。

  • cargo build --release
    编译发布版本（输出到 target/release/）。

  • rustc xxx 直接用 rustc 编译

  • cargo run
    编译并运行（= cargo build && cargo run）。

  • cargo check
    检查代码错误，但不生成二进制文件（比 build 更快）。

依赖与构建管理 ​

  • cargo add 新增依赖

  • cargo update
    更新 Cargo.lock 中的依赖到最新兼容版本。

  • cargo outdated
    检查项目中过时的依赖包。

  • cargo generate <template>
    从模板生成项目（需提前安装 cargo-generate 插件）。

  • cargo fetch
    下载（缓存）项目的依赖。

  • cargo package
    打包项目为 tar.gz 文件（用于发布或分发）。

测试与性能 ​

  • cargo test
    运行项目中的测试用例（包含单元测试和集成测试）。

  • cargo bench
    运行基准测试（需在 benches/ 目录中编写测试）。

  • cargo fix
    自动修复代码中的常见问题（依赖于 clippy 或 rustfmt）。

代码质量与格式化 ​

  • cargo fmt
    格式化代码（需安装 rustfmt，可通过 rustup component add rustfmt 获取）。

  • cargo clippy
    运行代码静态分析（检查潜在问题，需安装 clippy，通过 rustup component add clippy 获取）。

发布与包管理 ​

  • cargo publish
    发布包到 crates.io（需提前注册账号并登录）。

  • cargo yank [--vers]
    标记包版本为不可用（阻止他人下载）。

  • cargo unyank [--vers]
    取消标记包版本，恢复可用状态。

  • cargo search <keyword>
    在 crates.io 上搜索 Rust 包。

  • cargo owner --add <user> <crate>
    管理包的所有者（需拥有包的发布权限）。

工具与清理 ​

  • cargo install <crate>
    安装 Rust 二进制工具到本地（路径通常在 ~/.cargo/bin/）。

  • cargo uninstall <crate>
    卸载已安装的 Rust 工具。

  • cargo doc
    生成项目文档（HTML 格式，存于 target/doc/，可通过 cargo doc --open 直接打开）。

  • cargo clean
    清理构建生成的文件（删除 target/ 目录中的内容）。

  • cargo metadata
    输出项目元数据（JSON 格式，用于脚本或工具集成）。

  • cargo license
    显示项目的许可证信息（读取 Cargo.toml 中的 license 字段）。

工作区与多项目管理 ​

  • cargo workspaces list
    列出工作区中的所有项目（需在工作区根目录执行）。

  • cargo build --workspace
    编译工作区中的所有项目。

帮助与版本 ​

  • cargo help [command]
    查看具体命令的详细用法（如 cargo help build）。

  • cargo --version
    显示 Cargo 的版本信息。

说明 ​