# @routerhub/agent-rules

帮你自动生成给AI看的提示文件，这样每次AI都会参考你的规则

## 安装

在你的项目里安装即可：

```bash
pnpm i -D @routerhub/agent-rules
```

## 使用

安装完成后，只在当前项目的 `AGENTS.private.md` 中编写项目私有规则。

如果需要修改公共规则，请在 `agent-rules` 项目中维护，不要写到业务项目的 `AGENTS.private.md` 里。

写完 `AGENTS.private.md` 后，工具会自动生成项目可用的 `AGENTS.md` 和 `.github/copilot-instructions.md`。

首次执行 `pnpm i -D @routerhub/agent-rules` 时，会自动执行初始化：

- 自动生成 `AGENTS.md`
- 自动生成 `CLAUDE.md`
- 自动生成 `.github/copilot-instructions.md`
- 自动生成 `.github/instructions/*.instructions.md`
- 如果当前项目还没有 `AGENTS.private.md`，会自动创建模板文件

## 更新

当 `@routerhub/agent-rules` 有新版本时，锁文件不会自动追最新，需要手动更新：

```bash
pnpm update @routerhub/agent-rules --latest
```

更新后 `postinstall` 脚本会自动运行，重新同步规则文件。

> 直接 `pnpm i` 会按 `pnpm-lock.yaml` 中的锁定版本安装，必须加 `--latest` 才能拿到最新版本。

---

注意：`pnpm i` 只会自动执行一次初始化或同步，不会常驻启动 watch。

如果你希望修改 `AGENTS.private.md` 后自动重新生成规则文件，需要手动执行：

```bash
pnpm exec agent-rules watch
```