> For AI agents: the complete documentation index is available at /zh/llms.txt, the full documentation bundle is available at /zh/llms-full.txt.

# AI

为了帮助 AI 更全面地了解 Rstest 的功能、配置与最佳实践，从而在日常开发和问题排查过程中提供更准确的帮助，Rstest 提供了以下能力：

- [Agent prompt](#agent-prompt)
- [Agent Skills](#agent-skills)
- [llms.txt](#llmstxt)
- [Markdown 文档](#markdown-文档)
- [Markdown 报告器](#markdown-报告器)
- [AGENTS.md](#agentsmd)

## Agent prompt

如果你正在使用 Coding Agent（如 Claude Code、Cursor、Copilot 等），请复制下面与你项目匹配的 prompt。Agent 会读取链接中的指令，并根据你的项目类型安装依赖、创建配置并编写测试。

### 设置 Rstest

如果当前项目还没有配置测试框架，使用这个 prompt：


For your Agent

设置 Rstest

复制这个 prompt 并发送给你的 Coding Agent。

复制 Prompt

Set up Rstest, the JavaScript testing framework, in this project by following the instructions here:
https://rstest.rs/guide/start/agent-install.md

### 从 Jest、Vitest 或 Playwright 迁移

如果要将现有的 Jest、Vitest 或 Playwright Test 项目迁移到 Rstest，使用这个 prompt。Playwright Test 项目会迁移到 `@rstest/playwright`。为方便使用，链接中的指令内联了完整的 [migrate-to-rstest](https://github.com/rstackjs/agent-skills#migrate-to-rstest) skill，无需额外安装；你也可以[安装该 skill](#agent-skills) 后直接使用：


For your Agent

迁移到 Rstest

复制这个 prompt 并发送给你的 Coding Agent。

复制 Prompt

Migrate this project to Rstest, the JavaScript testing framework. Detect whether it uses Jest, Vitest, or Playwright Test; for Playwright Test, migrate to @rstest/playwright. Follow the instructions here:
https://rstest.rs/guide/start/agent-migrate.md

## Agent Skills

Agent Skills 是可安装到 Agent 中的领域知识包，能够让 Agent 在特定场景下更准确、更专业地给出建议或执行操作。

我们在 [rstackjs/agent-skills](https://github.com/rstackjs/agent-skills) 仓库中为 Rstack 生态提供了许多 Skills，其中关于 Rstest 的 Skills 包括：

- [migrate-to-rstest](https://github.com/rstackjs/agent-skills#migrate-to-rstest)：将 Jest、Vitest 或 Playwright Test 项目迁移到 Rstest；Playwright E2E 测试使用 `@rstest/playwright`。
- [rstest-best-practices](https://github.com/rstackjs/agent-skills#rstest-best-practices)：Rstest 相关的最佳实践。
- [rstest-debugging](https://github.com/rstackjs/agent-skills#rstest-debugging)：系统化 Debug Rstest 问题，包括性能回归。适用于 Rstest 比预期更慢、比 Jest 或 Vitest 更慢，或需要在尝试配置或代码改动前判断瓶颈是在构建启动还是测试执行中的场景。

在支持 Skills 的 Coding Agent 中，可以通过以下命令使用 [skills](https://www.npmjs.com/package/skills) 包安装指定的 Skill：


```sh [npx]
npx skills add rstackjs/agent-skills --skill migrate-to-rstest
```

```sh [yarn]
yarn dlx skills add rstackjs/agent-skills --skill migrate-to-rstest
```

```sh [pnpm]
pnpm dlx skills add rstackjs/agent-skills --skill migrate-to-rstest
```

```sh [bunx]
bunx skills add rstackjs/agent-skills --skill migrate-to-rstest
```

```sh [deno]
deno run -A npm:skills add rstackjs/agent-skills --skill migrate-to-rstest
```

安装完成后，用自然语言输入相关提示词即可触发对应 Skill，例如：

```
帮我把这个 Playwright Test 项目迁移到 @rstest/playwright
```

## llms.txt

[llms.txt](https://llmstxt.org/) 是一种帮助 LLM 发现和使用项目文档的标准规范。Rstest 遵循该规范，发布了以下两个文件：

- [llms.txt](https://rstest.rs/llms.txt)：结构化索引文件，包含所有文档页面的标题、链接与简要描述。

```
https://rstest.rs/llms.txt
```

- [llms-full.txt](https://rstest.rs/llms-full.txt)：完整内容文件，将所有文档页面的内容合并为单个文件。

```
https://rstest.rs/llms-full.txt
```

你可以根据使用场景选择合适的文件：

- `llms.txt` 体积较小、消耗 token 少，适合让 AI 按需获取具体页面。
- `llms-full.txt` 包含全量文档内容，无需 AI 逐一跟随链接，适合需要 AI 全面了解 Rstest 的场景，但会消耗更多 token，建议在支持大上下文窗口的 AI 工具中使用。

## Markdown 文档

Rstest 文档的每个页面都提供对应的 `.md` 纯文本版本，可直接作为上下文提供给 AI。你可以在文档任意页面的标题下方点击「复制 Markdown」或「复制 Markdown 链接」按钮，获取该页面对应的 Markdown 文件内容或链接。

```
https://rstest.rs/guide/start/index.md
```

将 Markdown 链接或内容提供给 AI，即可让其精确了解某一具体章节的内容，适合在针对性问题排查或查阅特定内容时使用。

## Markdown 报告器

当你希望 AI 直接消费测试结果时，可以使用 `md` 报告器。它会将测试结果输出为一份 markdown 文档到 stdout，相比带颜色的终端日志更容易被 LLM 解析，输出也更简洁，通常能减少 token 消耗。

在 Agent 环境中，当你没有显式配置 reporters 时，Rstest 会默认使用 `md`。

```bash
npx rstest --reporters=md
```

你也可以在 `rstest.config.ts` 中配置它，并在本地或 CI 工作流中与其他报告器组合使用。

```ts
import { defineConfig } from '@rstest/core';

export default defineConfig({
  reporters: ['md'],
});
```

更多介绍请参考 [Markdown 报告器](/zh/guide/basic/reporters.md#markdown-报告器)。

## AGENTS.md

你可以在使用 Rstest 的项目根目录创建一个 `AGENTS.md` 文件。该文件遵循 [AGENTS.md](https://agents.md/) 规范，向 Agents 提供项目的关键信息。

以下是可以在 `AGENTS.md` 中添加的 Rstest 相关内容示例：

```markdown wrapCode
# AGENTS.md

You are an expert in JavaScript, Rspack, Rsbuild, and Rstest. You write maintainable, performant, and accessible tests.

## Tools

### Rstest

- Run `npm run test` to run tests (`npx rstest`)
- Run `npm run test:watch` to run tests in watch mode (`npx rstest --watch`)

## Docs

- Rstest: https://rstest.rs/llms.txt
```

你也可以根据项目的实际情况进行修改，添加更多关于项目结构、整体架构等多方面的信息，以便 Agents 更好地理解你的项目。

::: tip

如果你使用的是 Claude Code，可以创建一个 `CLAUDE.md` 文件，并在其中引用 `AGENTS.md` 文件。

```markdown title="CLAUDE.md"
@AGENTS.md
```

:::