# Rstack CLI

> Rstack CLI brings the Rstack toolchain together with one CLI, one configuration, and one consistent workflow.

## 指南

- [快速上手](/zh/guide/quick-start.md): 安装 Rstack CLI、添加项目脚本，并配置 Rstack JavaScript 工具链。
- [配置](/zh/guide/configuration.md): Rstack 将项目所用工具的配置集中到一份文件中。通过 define.*() API 定义项目实际需要的配置即可。
- [AI](/zh/guide/ai.md): 通过 Agent Skills、llms.txt、Markdown 文档和 AGENTS.md，配合 Coding Agent 使用 Rstack CLI。
- [API 参考](/zh/guide/api-reference.md): Rstack 提供统一的配置 API，并通过专用子路径重导出 Rsbuild、Rslib、Rstest 和 Rslint 的公开 API。建议优先从这些子路径导入，以统一依赖入口，并确保 API 与 Rstack 集成的工具版本保持一致。
- [迁移到 Rstack CLI](/zh/guide/migration.md): 使用推荐的迁移 Skill，将现有项目迁移到 Rstack CLI。
- [测试](/zh/guide/testing.md): Rstack 使用 Rstest 运行测试。 命令行选项和子命令请参阅 rs test。
- [格式化](/zh/guide/formatting.md): Rstack CLI 提供了基于 Prettier 的格式化工具。相比直接使用 Prettier，rs fmt 的性能更好，主要得益于以下两点： 并行格式化：通过 worker 池并行格式化文件。Yuku 解析器：默认使用高性能的 Yuku 解析器处理 JavaScript、JSX 和 TypeScript 文件。持久化缓存：基于文件内容缓存结果，后续运行可以跳过未变化文件的格式化。 rs fmt 兼容 Prettier 的选项和插件，并提供更多内置能力，例如支持排序 package.json 字段。
- [Monorepo](/zh/guide/monorepo.md): 本指南介绍如何在 Monorepo 中使用 Rstack CLI，以及如何让它与 Turborepo、Nx 等任务编排工具协同工作。 主要内容包括管理 Rstack 依赖、在根目录统一配置代码检查、格式化和暂存文件任务，以及为 Web 应用和库项目定义独立配置。
- [dev](/zh/guide/cli/dev.md): rs dev 命令用于启动应用的 Rsbuild 开发服务器。它会以开发模式编译源码、监听文件变化，并按需进行模块热更新（HMR）或刷新页面。
- [build](/zh/guide/cli/build.md): rs build 命令使用 Rsbuild 构建应用的生产版本。
- [preview](/zh/guide/cli/preview.md): rs preview 命令使用 Rsbuild 在本地预览应用的生产构建。
- [lib](/zh/guide/cli/lib.md): rs lib 命令使用 Rslib 构建库产物。
- [doc](/zh/guide/cli/doc.md): rs doc 命令使用 Rspress 开发、构建和预览文档站点。 使用该命令前，请安装 @rspress/core：
- [test](/zh/guide/cli/test.md): rs test 命令使用 Rstest 运行测试。 如需了解更多测试相关用法，请参阅测试。
- [lint](/zh/guide/cli/lint.md): rs lint 命令使用 Rslint 检查源代码。
- [fmt](/zh/guide/cli/fmt.md): rs fmt 命令用于格式化文件或检查文件格式。详细用法请参考格式化指南。
- [setup](/zh/guide/cli/setup.md): rs setup 命令用于安装仓库级 Git hooks，并在调用该命令的项目中运行 hooks。
- [staged](/zh/guide/cli/staged.md): rs staged 命令使用 lint-staged 对 Git 暂存文件运行任务。 rs staged 可用于在提交代码前，对暂存文件运行 linter、格式化工具或其他检查。 常见做法是将 rs staged 与 rs setup 配合使用，通过 pre-commit hook 运行暂存文件任务。