# 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): 通过 define API 在 rstack.config.ts 中配置 Rstack 工具，包括应用构建、测试、代码检查和格式化等。
- [AI](/zh/guide/ai.md): 通过 Agent Skills、llms.txt、Markdown 文档和 AGENTS.md，配合 Coding Agent 使用 Rstack CLI。
- [API 参考](/zh/guide/api-reference.md): Rstack 公共 API，包括配置辅助方法、各工具重新导出的 API 和 TypeScript 类型声明。
- [迁移到 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 dev server，配置 HMR、主机、端口和 define.app()。
- [build](/zh/guide/cli/build.md): 使用 rs build 构建生产环境应用，并通过 define.app() 配置 Rsbuild 产物。
- [preview](/zh/guide/cli/preview.md): 运行 rs build 后，使用 rs preview 在本地预览应用的生产构建产物。
- [lib](/zh/guide/cli/lib.md): 通过 rs lib 构建和开发库，包括 build、inspect 和 mf-dev 等命令。
- [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 检查源码、自动修复问题、运行类型检查，并通过 define.lint() 配置预设。
- [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 任务。