OpenCode 规则文件

你可以通过创建 AGENTS.md 文件向 opencode 提供自定义指令。这类似于 CLAUDE.md 或 Cursor 的规则。它包含将被包含在 LLM 上下文中的指令，以自定义其针对特定项目的行为。

初始化

要创建新的 AGENTS.md 文件，你可以在 opencode 中运行 /init 命令。

提示：你应该将项目的 AGENTS.md 文件提交到 Git

这将扫描你的项目及其所有内容，以了解项目是关于什么的，并生成包含这些信息的 AGENTS.md 文件。这有助于 opencode 更好地导航项目。

如果你有现有的 AGENTS.md 文件，这将尝试添加到它。

如果你打算手动创建，以下是一些示例内容。

<!-- AGENTS.md -->
# SST v3 Monorepo 项目

这是一个使用 TypeScript 的 SST v3 monorepo。项目使用 bun workspaces 进行包管理。

## 项目结构

- `packages/` - 包含所有工作区包（functions、core、web 等）
- `infra/` - 按服务拆分的基础设施定义（storage.ts、api.ts、web.ts）
- `sst.config.ts` - 带有动态导入的主 SST 配置

## 代码标准

- 使用启用严格模式的 TypeScript
- 共享代码放在 `packages/core/` 中，带有适当的导出配置
- 函数放在 `packages/functions/` 中
- 基础设施应该按逻辑文件拆分到 `infra/` 中

## Monorepo 约定

- 使用工作区名称导入共享模块：`@my-app/core/example`

文件类型

opencode 也支持从多个位置读取 AGENTS.md 文件。这服务于不同的目的。

我们上面看到的，将 AGENTS.md 放在项目根目录中的，是项目特定的规则。这些仅在你在此目录或其子目录中工作时适用。

全局规则

你也可以在 ~/.config/opencode/AGENTS.md 文件中有全局规则。这会在所有 opencode 会话中应用。

由于这不会提交到 Git 或与团队共享，我们建议使用它来指定 LLM 应遵循的任何个人规则。

优先级

所以当 opencode 启动时，它会查找：

本地文件 - 从当前目录向上遍历
全局文件 - 检查 ~/.config/opencode/AGENTS.md
如果你同时有全局和项目特定的规则，opencode 会将它们组合在一起。

参考链接：https://www.opencodecn.com/docs/rules