Skip to content

docs: clarify CLI invocation in quick start #522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chenjiahan merged 1 commit into from
Sep 26, 2026
Merged

docs: clarify CLI invocation in quick start #522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions scripts/dictionary.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Custom Dictionary Words
applypatch
bundleless
bunx
cdpath
clippy
dirents
Expand Down
54 changes: 41 additions & 13 deletions website/docs/en/guide/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,23 @@ Install [`rstack`](https://www.npmjs.com/package/rstack) as a development depend

## CLI commands

Add the commands your project needs to the `scripts` field in `package.json`. For example:
The following commands are available:

- [`rs dev`](./cli/dev): Start the application development server.
- [`rs build`](./cli/build): Build the application for production.
- [`rs preview`](./cli/preview): Preview the application's production build locally.
- [`rs lib`](./cli/lib): Build a library with Rslib.
- [`rs doc`](./cli/doc): Develop, build, or preview a documentation site with Rspress.
- [`rs test`](./cli/test): Run tests with Rstest.
- [`rs check`](./cli/check): Run linting and formatting checks, with optional TypeScript type checking.
- [`rs lint`](./cli/lint): Lint source code with Rslint.
- [`rs fmt`](./cli/fmt): Format code.
- [`rs hooks`](./cli/hooks): Install, update, or uninstall repository-level Git hooks.
- [`rs staged`](./cli/staged): Run tasks against files staged in Git with lint-staged.

### Run with package scripts

Add frequently used commands to the `scripts` field in `package.json`:

```json title="package.json"
{
Expand All @@ -140,21 +156,33 @@ Add the commands your project needs to the `scripts` field in `package.json`. Fo
}
```

Then run the script with your package manager. For example, to run the `dev` script above:

<PackageManagerTabs
command={{
pnpm: 'pnpm run dev',
npm: 'npm run dev',
yarn: 'yarn run dev',
bun: 'bun run dev',
}}
/>

Package scripts use the project-local `rs` binary, so Rstack CLI does not need to be installed globally.

The following commands are available:
### Run directly in the terminal

- [`rs dev`](./cli/dev): Start the application development server.
- [`rs build`](./cli/build): Build the application for production.
- [`rs preview`](./cli/preview): Preview the application's production build locally.
- [`rs lib`](./cli/lib): Build a library with Rslib.
- [`rs doc`](./cli/doc): Develop, build, or preview a documentation site with Rspress.
- [`rs test`](./cli/test): Run tests with Rstest.
- [`rs check`](./cli/check): Run linting and formatting checks, with optional TypeScript type checking.
- [`rs lint`](./cli/lint): Lint source code with Rslint.
- [`rs fmt`](./cli/fmt): Format code.
- [`rs hooks`](./cli/hooks): Install, update, or uninstall repository-level Git hooks.
- [`rs staged`](./cli/staged): Run tasks against files staged in Git with lint-staged.
You can also run Rstack CLI through your package manager without adding a package script. For example, to start the development server directly:

<PackageManagerTabs
command={{
pnpm: 'pnpm rs dev',

@chatgpt-codex-connector chatgpt-codex-connector Bot Sep 26, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Use pnpm exec to bypass package-script dispatch

For an existing project that already defines an rs script, pnpm rs dev dispatches that package script instead of the installed node_modules/.bin/rs, so this “direct” example can execute the wrong command. I confirmed this with pnpm 10.28.1; pnpm help run describes it as running a defined package script, while pnpm help exec explicitly runs a command in the project context. Use pnpm exec rs dev here, update the later alias example similarly, and mirror both corrections in the Chinese guide.

AGENTS.md reference: AGENTS.md:L44-L44

Useful? React with 👍 / 👎.

npm: 'npx rs dev',
yarn: 'yarn exec rs dev',
bun: 'bunx rs dev',
}}
/>

Rstack CLI also provides `rstack` as an alias for `rs`. For example, `pnpm rstack dev` is equivalent to `pnpm rs dev`.

## Configure Rstack CLI \{#configure-rstack}

Expand Down
56 changes: 42 additions & 14 deletions website/docs/zh/guide/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,23 @@ Available templates: app-vanilla, app-vanilla-ts, app-react, app-react-ts, app-p

## CLI 命令 \{#cli-commands}

在 `package.json` 的 `scripts` 字段中添加项目所需的命令，例如：
Rstack CLI 提供以下命令：

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

### 通过项目脚本运行 \{#run-with-package-scripts}

将常用命令添加到 `package.json` 的 `scripts` 字段中：

```json title="package.json"
{
Expand All @@ -140,21 +156,33 @@ Available templates: app-vanilla, app-vanilla-ts, app-react, app-react-ts, app-p
}
```

package scripts 会使用项目本地安装的 `rs` 命令，因此无需全局安装 Rstack CLI。
然后通过包管理器运行对应的脚本。例如，运行上面定义的 `dev` 脚本：

Rstack CLI 提供以下命令：
<PackageManagerTabs
command={{
pnpm: 'pnpm run dev',
npm: 'npm run dev',
yarn: 'yarn run dev',
bun: 'bun run dev',
}}
/>

- [`rs dev`](./cli/dev)：启动应用开发服务器。
- [`rs build`](./cli/build)：构建应用的生产版本。
- [`rs preview`](./cli/preview)：在本地预览应用的生产构建产物。
- [`rs lib`](./cli/lib)：使用 Rslib 构建库。
- [`rs doc`](./cli/doc)：使用 Rspress 开发、构建或预览文档站点。
- [`rs test`](./cli/test)：使用 Rstest 运行测试。
- [`rs check`](./cli/check)：运行 lint 和格式检查，并可选启用 TypeScript 类型检查。
- [`rs lint`](./cli/lint)：使用 Rslint 检查源代码。
- [`rs fmt`](./cli/fmt)：格式化代码。
- [`rs hooks`](./cli/hooks)：安装、更新或卸载仓库级 Git hooks。
- [`rs staged`](./cli/staged)：使用 lint-staged 对 Git 暂存区中的文件运行任务。
项目脚本会使用本地安装的 `rs` 命令，因此无需全局安装 Rstack CLI。

### 直接在终端运行 \{#run-directly-in-the-terminal}

也可以直接通过包管理器运行 Rstack CLI，无需在 `package.json` 中添加脚本。例如，直接启动开发服务器：

<PackageManagerTabs
command={{
pnpm: 'pnpm rs dev',
npm: 'npx rs dev',
yarn: 'yarn exec rs dev',
bun: 'bunx rs dev',
}}
/>

Rstack CLI 也提供 `rstack` 作为 `rs` 的别名。例如，`pnpm rstack dev` 与 `pnpm rs dev` 等效。

## 配置 Rstack CLI \{#configure-rstack}

Expand Down
Loading