#快速上手

Rstack CLI 通过统一的命令行和配置文件整合 Rstack 工具链。本指南将介绍如何创建新的 Rstack 项目或在现有项目中添加 Rstack，以及可以使用的工作流。

#环境准备

Rstack 支持使用 Node.js、Deno 或 Bun 作为 JavaScript 运行时。

参考以下安装指南，选择一种运行时：

• 安装 Node.js
• 安装 Bun
• 安装 Deno

#创建 Rstack 项目

使用 create-rstack 可以快速创建已配置好 Rstack 的应用、库或文档站点。推荐使用 pnpm 作为包管理器。

pnpm create rstack@latest

npm create rstack@latest

yarn create rstack

bun create rstack@latest

deno init --npm rstack@latest

按照提示操作即可完成创建。

项目创建完成后，执行以下步骤：

• 执行 pnpm install（或其他包管理器的 install 命令）安装依赖。
• 执行 pnpm run dev 启动开发服务器或监听模式。

#模板

创建项目时，可选择 create-rstack 提供的下列模板：

所有应用和库模板均提供 JavaScript 和 TypeScript 版本。

#当前目录

如需在当前目录中创建项目，将项目名称或路径设置为 .：

◆  Create Rstack Project
│
◇  Project name or path
│  .
│
◇  "." is not empty, please choose:
│  Continue and override files

#非交互模式

create-rstack 支持通过命令行选项进入非交互模式。该模式会跳过提示并直接创建项目，适合脚本、CI 和自动化场景。

例如，以下命令将在 my-project 目录中创建一个 TypeScript React 应用：

npx -y create-rstack@latest my-project --template app-react-ts

# 使用缩写
npx -y create-rstack@latest my-project -t app-react-ts

# 跳过 Git 仓库初始化
npx -y create-rstack@latest my-project -t app-react-ts --no-git

create-rstack 支持的全部 CLI 选项如下：

Usage: create-rstack [dir] [options]

Options:
  -h, --help                display help for command
  -d, --dir <dir>           create project in specified directory
  -t, --template <tpl>      specify the template to use
  --no-git                  skip Git repository initialization
  --override                override files in target directory
  --package-name <name>     specify the package name
  --template-version <ver>  specify the npm template version

Available templates: app-vanilla, app-vanilla-ts, app-react, app-react-ts, app-preact, app-preact-ts, app-vue, app-vue-ts, app-lit, app-lit-ts, app-svelte, app-svelte-ts, app-solid, app-solid-ts, lib-node, lib-node-ts, lib-react, lib-react-ts, lib-vue, lib-vue-ts, lib-svelte, lib-svelte-ts, lib-solid, lib-solid-ts, doc, doc-i18n

#安装 Rstack

在已有 package.json 的项目中，将 rstack 安装为开发依赖：

npm install -D rstack

yarn add -D rstack

pnpm add -D rstack

bun add -d rstack

#CLI 命令

在 package.json 的 scripts 字段中添加项目所需的命令，例如：

{
  "scripts": {
    "dev": "rs dev",
    "build": "rs build",
    "preview": "rs preview",
    "test": "rs test",
    "check": "rs check",
    "lint": "rs lint",
    "format": "rs fmt"
  }
}

package scripts 会使用项目本地安装的 rs 命令，因此无需全局安装 Rstack。

Rstack 提供以下命令：

• rs dev：启动应用开发服务器。
• rs build：构建应用的生产版本。
• rs preview：在本地预览应用的生产构建产物。
• rs lib：使用 Rslib 构建库。
• rs doc：使用 Rspress 开发、构建或预览文档站点。
• rs test：使用 Rstest 运行测试。
• rs check：运行 lint 和格式检查，并可选启用 TypeScript 类型检查。
• rs lint：使用 Rslint 检查源代码。
• rs fmt：格式化代码。
• rs setup：安装仓库级 Git hooks。
• rs staged：使用 lint-staged 对 Git 暂存区中的文件运行任务。

#配置 Rstack

在项目根目录创建 rstack.config.ts，并注册项目所需的配置。以下是一个包含应用、测试和代码检查的最小示例：

// Rstack configuration guide: https://rstack.rs/config
import { define } from 'rstack';

define.app({
  // Rsbuild 配置
});

define.test({
  // Rstest 配置
});

define.lint({
  // Rslint 配置
});

所有可用的配置 API 请参见配置。

#AI

如需了解如何配合 Coding Agent 使用 Rstack CLI，请参阅 AI 指南。