# Rstack CLI

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

## 指南

- [快速上手](/zh/guide/quick-start.md): 创建 Rstack 项目，或在现有项目中安装 Rstack CLI 并配置 Rstack JavaScript 工具链。
- [配置](/zh/guide/configuration.md): Rstack CLI 将项目所用工具的配置集中到一份文件中。通过 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 CLI 提供统一的配置 API，并通过专用子路径重导出 Rsbuild、Rslib、Rstest 和 Rslint 的公开 API。建议优先从这些子路径导入，而不是直接从各工具的 core 包导入，以统一依赖入口，并确保 API 与 Rstack CLI 集成的工具版本匹配。
- [迁移到 Rstack CLI](/zh/guide/migration.md): 使用推荐的迁移 Skill，将现有项目迁移到 Rstack CLI。
- [测试](/zh/guide/testing.md): 使用 Rstack CLI 运行测试，通过 Rstest 适配器继承应用或库配置，并配置多个测试项目。
- [格式化](/zh/guide/formatting.md): 使用 Rstack CLI 格式化文件，支持与 Prettier 兼容的选项、插件、并行格式化和持久化缓存。
- [Git hooks](/zh/guide/git-hooks.md): 使用 Rstack CLI 配置仓库级 Git hooks，并在提交前自动检查和格式化暂存文件。
- [Monorepo](/zh/guide/monorepo.md): 在 Monorepo 中使用 Rstack CLI 配置共享检查、格式化、暂存文件任务和项目工作流。
- [IDE 集成](/zh/guide/ide-integration.md): 介绍如何在 VS Code 中使用 Rstack 官方扩展进行代码检查、格式化和测试。
- [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 文档站点。
- [test](/zh/guide/cli/test.md): rs test 命令使用 Rstest 运行测试。 如需了解更多测试相关用法，请参阅测试。
- [check](/zh/guide/cli/check.md): 同时运行 lint 和格式检查，并可选启用 TypeScript 类型检查。
- [lint](/zh/guide/cli/lint.md): rs lint 命令使用 Rslint 检查源代码。
- [fmt](/zh/guide/cli/fmt.md): rs fmt 命令用于格式化文件或检查文件格式。详细用法请参考格式化指南。
- [hooks](/zh/guide/cli/hooks.md): 使用 Rstack CLI 安装、配置、排查并安全移除仓库级 Git hooks。
- [staged](/zh/guide/cli/staged.md): 使用 rs staged 命令对 Git 暂存文件运行 lint-staged 任务。