# 配合你的 AI 编程助手使用 vagejs 你的助手懂规则。

> 用 AI 编程助手搭建网站。vagejs 支持 Claude Code、Codex、Cursor、GitHub Copilot 和 Gemini CLI，这里说明每个工具会读取哪些文件。

vagejs 是一款为 AI 编程助手打造的静态网站生成器。每个新网站都包含一个 `AGENTS.md` 说明文件、一条以数据形式描述整个工具的命令，以及能指出具体要修改哪个文件的检查，所以 Claude Code、Codex、Cursor、GitHub Copilot、Gemini CLI 和其他助手都能不靠猜测地搭建你的网站。

更新于 2026年10月28日

不知道该问什么？[网站提示词生成器](https://vagejs.com/prompts/builder/)会根据你的几个回答，写出你的第一条提示词。还在挑选工具？我们的指南[适合 AI 编程助手的静态网站生成器](https://vagejs.com/guides/static-site-generator-for-ai-coding-assistants/)讲解了该看哪些方面，并比较了常见的选择。

## 你的助手能得到什么？

-   项目文件夹里的 **`AGENTS.md`**：包含命令、常见任务的做法（添加页面、重命名页面、添加博客文章、添加语言、让组件可交互）以及规则，比如“绝不编造日期或作者”。大多数编程助手会自己读取这个文件。
-   **`CLAUDE.md`**，里面只有一行 `@AGENTS.md`，这样 Claude Code 也会加载同样的说明。

不用 vagejs？免费的 [AGENTS.md 生成器](https://vagejs.com/tools/agents-md-generator/)可以为任何网站项目生成一份。

-   **`npx vage info --json`**：每条命令、选项和设置，以及配置和 frontmatter 的 JSON Schema。助手会被告知用它来代替猜测。
-   `build`、`check`、`audit` 和各个部署命令的 **`--json` 输出**，其中每个问题都会指出要修改的文件。
-   **MCP 服务器（可选）。** `npx -p vagejs vage mcp` 让支持 MCP 的助手可以直接调用 vagejs：描述它、检查网站、列出页面和外部链接。全部都是只读的：批准链接和发布仍由你来做。
-   **等你点头才发布。** 部署、推送和 IndexNow 提交都会先展示计划，然后停下来等你同意，所以助手无法自行发布你的网站。

助手甚至可以替你创建网站。当 `npm create vagejs@latest` 在助手或脚本中运行时，它不会提问，而是打印出后续步骤，不会启动服务器。

## 每个工具读取哪个说明文件？

| 工具 | 自动读取 | 需要的设置 |
| --- | --- | --- |
| [Claude Code](https://vagejs.com/agents/claude-code/) | `CLAUDE.md`，新版本也会读取 `AGENTS.md` | 无：入门模板的 `CLAUDE.md` 会导入 `AGENTS.md` |
| [OpenAI Codex](https://vagejs.com/agents/codex/) | `AGENTS.md` | 无 |
| [Cursor](https://vagejs.com/agents/cursor/) | `AGENTS.md` 和 `.cursor/rules/*.mdc` | 无 |
| [GitHub Copilot](https://vagejs.com/agents/github-copilot/) | `AGENTS.md` 和 `.github/copilot-instructions.md` | 在 VS Code 中无需设置；云端助手需要一个设置工作流 |
| [Gemini CLI](https://vagejs.com/agents/gemini-cli/) | `GEMINI.md` | 添加一项设置以读取 `AGENTS.md` |
| [其他助手](https://vagejs.com/agents/other/) | 各不相同 | Devin Desktop、Cline、Aider、Zed 等 |

每篇指南都会介绍如何设置、该工具如何找到说明文件、哪些命令可以让它自由运行，以及一个只适用于该工具的小技巧。

## 每个助手都遵循什么流程？

terminal

```
npx vage info --json     # learn the commands and settings
# edit pages in src/pages/
npx vage check --json    # fix every error it reports
npx vage build --json    # build the finished site
```

说明会告诉助手：每次修改后都运行 `check`，直到它报告零错误才算完成。它修不好的警告会报告给你，而不是藏起来。

## 哪些规则值得坚持？

-   **安全的命令让它自由运行。** `npm run check`、`npm run build` 和 `npx vage info` 只会读取你的项目或写入 `dist/`。
-   **发布保持手动。** 不要把 `vage deploy`、`deploy:github` 或 `indexnow` 放进自动批准列表，也不要在你在乎的项目上使用“全部批准”模式。
-   **事实由你提供。** 说明会告诉助手，标题、日期、作者和各种说法都要向你询问，而不是自己编造。如果你的助手编造了内容，让它回头去看 `AGENTS.md`。
-   **优先使用普通页面。** `AGENTS.md` 会告诉助手使用 Markdown 页面和纯 HTML，除非你要求使用 [MDX 或可交互组件](https://vagejs.com/zh-CN/features/react-vue-mdx/)，因为每个可交互组件都会增加 JavaScript。
-   **机密信息不要放进聊天。** API 密钥应该放在环境变量或 `vage connect` 里，绝不要写进提示词或页面。

准备好要粘贴的内容了吗？[提示词库](https://vagejs.com/zh-CN/prompts/)里有适用于日常任务的提示词，这些工具都能用。