news 2026/4/22 6:12:58

OpenCode Rules 完整指南

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
OpenCode Rules 完整指南

概述

OpenCode的Rules功能通过创建AGENTS.md文件来提供自定义指令,类似于Cursor的规则。这些指令会包含在LLM的上下文中,用于定制特定项目的行为,让AI助手更好地理解项目需求和工作流程。

初始化

自动创建

  • 运行/init命令自动扫描项目并生成AGENTS.md
  • 建议将AGENTS.md文件提交到Git以便团队共享
  • 如果文件已存在,会尝试添加内容而不是覆盖

支持的规则类型

1. 项目规则

  • 位置:项目根目录的AGENTS.md
  • 作用域:仅在该目录及其子目录中生效
  • 共享性:通过Git与团队共享
  • 适用场景:项目特定的编码标准、架构约定、工具配置等

2. 全局规则

  • 位置~/.config/opencode/AGENTS.md
  • 作用域:所有OpenCode会话
  • 用途:个人规则,不与团队共享
  • 适用场景:个人编码偏好、工作习惯、常用工具配置等

3. Claude Code兼容性规则

OpenCode为从Claude Code迁移的用户提供无缝兼容:

类型文件位置使用条件
项目规则CLAUDE.md项目目录中,无AGENTS.md时使用
全局规则~/.claude/CLAUDE.md~/.config/opencode/AGENTS.md时使用
技能~/.claude/skills/参见Agent Skills文档
禁用兼容性

可通过环境变量选择性禁用Claude Code兼容性:

exportOPENCODE_DISABLE_CLAUDE_CODE=1# 禁用所有.claude支持exportOPENCODE_DISABLE_CLAUDE_CODE_PROMPT=1# 仅禁用~/.claude/CLAUDE.mdexportOPENCODE_DISABLE_CLAUDE_CODE_SKILLS=1# 仅禁用.claude/skills

优先级规则

OpenCode启动时按以下顺序查找规则文件(每个类别中第一个匹配的文件获胜):

  1. 本地文件:从当前目录向上遍历

    • AGENTS.mdCLAUDE.mdCONTEXT.md
  2. 全局文件~/.config/opencode/AGENTS.md

  3. Claude Code文件~/.claude/CLAUDE.md(除非被禁用)

示例:如果同时有AGENTS.mdCLAUDE.md,只使用AGENTS.md

自定义指令配置

使用opencode.json

可以通过opencode.json或全局配置文件指定自定义指令文件:

{"$schema":"https://opencode.ai/config.json","instructions":["CONTRIBUTING.md","docs/guidelines.md",".cursor/rules/*.md"]}

远程指令支持

支持从远程URL加载指令,便于团队共享规则:

{"$schema":"https://opencode.ai/config.json","instructions":["https://raw.githubusercontent.com/my-org/shared-rules/main/style.md"]}

注意事项

  • 远程指令获取超时时间:5秒
  • 所有指令文件与AGENTS.md内容合并

引用外部文件

OpenCode提供两种方式引用外部文件,实现规则的模块化管理:

1. 使用opencode.json(推荐)

支持glob模式,特别适合复杂项目结构:

{"$schema":"https://opencode.ai/config.json","instructions":["docs/development-standards.md","test/testing-guidelines.md","packages/*/AGENTS.md"]}

2. 在AGENTS.md中手动指令

通过明确的加载指令实现按需加载:

# TypeScript项目规则 ## 外部文件加载 关键:遇到文件引用时,根据需要使用Read工具加载 指令: - 不要预加载所有引用 - 基于实际需要懒加载 - 加载后的内容作为强制指令覆盖默认设置 - 必要时递归跟随引用 ## 指导文档 对于TypeScript代码风格:@docs/typescript-guidelines.md 对于React组件架构:@docs/react-patterns.md 对于REST API设计:@docs/api-standards.md 对于测试策略:@test/testing-guidelines.md ## 通用指导 读取以下文件,与所有工作流程相关:@rules/general-guidelines.md

实际应用示例

完整的AGENTS.md结构示例

# SST v3 Monorepo项目 这是使用bun工作区的SST v3 monorepo TypeScript项目。 ## 项目结构 - `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` - 遵循语义化版本控制 - 保持依赖项的版本一致性

最佳实践建议

Monorepo项目

  • 使用opencode.json的glob模式(如packages/*/AGENTS.md)更易维护
  • 通过符号链接或git子模块共享规则
  • 为不同的包类型创建专门的规则模板

规则组织策略

  • 保持AGENTS.md简洁,引用详细指导文档
  • 创建模块化、可重用的规则文件
  • 确保OpenCode仅在特定任务需要时加载文件

团队协作

  • 将项目特定的AGENTS.md提交到版本控制
  • 建立统一的规则模板和标准
  • 定期审查和更新规则内容

迁移策略

对于从Claude Code迁移的团队:

  1. 保留现有的CLAUDE.md文件
  2. 逐步迁移到AGENTS.md格式
  3. 利用OpenCode的兼容性功能确保平滑过渡

高级功能

技能集成

  • OpenCode支持~/.claude/skills/目录中的技能定义
  • 技能可以扩展AI助手的能力
  • 支持自定义工具和工作流程

动态规则加载

  • 支持基于项目类型的动态规则选择
  • 可以根据文件类型、目录结构应用不同规则
  • 支持条件规则应用

总结

OpenCode的Rules系统提供了强大而灵活的自定义指令管理功能,既支持个人定制,又便于团队协作。通过合理的规则组织和管理,可以显著提升AI辅助编程的效率和准确性。

该系统的核心优势包括:

  • 层次化管理:支持项目、全局和兼容性规则
  • 灵活性:多种配置方式和引用策略
  • 向后兼容:平滑迁移路径
  • 团队友好:易于共享和维护

掌握这些规则功能将帮助开发者构建更智能、更高效的AI辅助编程环境。

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/4/17 23:31:13

Java基于Spring Boot+Vue的学业导师管理系统的设计与实现

所需该项目可以在最下面查看联系方式,为防止迷路可以收藏文章,以防后期找不到 项目介绍 在当今高等教育体系中,本科生学业导师制度已成为提升教学质量、促进学生个性化发展的重要途径。然而,随着高校扩招和学生人数的激增&#…

作者头像 李华
网站建设 2026/4/16 15:57:35

亲测好用9个AI论文写作软件,专科生轻松搞定毕业论文!

亲测好用9个AI论文写作软件,专科生轻松搞定毕业论文! 专科生的论文写作救星,AI 工具如何改变你的学习节奏? 在当今这个信息爆炸的时代,学术写作早已不再是少数人的专属。对于专科生而言,撰写一篇合格的毕业…

作者头像 李华
网站建设 2026/4/16 19:23:02

专精特新小巨人发展,为何必须依靠外脑?又该找谁?

专精特新小巨人发展,为何必须依靠外脑?又该找谁?专精特新小巨人企业正站在发展的关键节点:一方面拥有核心技术优势,另一方面却面临从“技术冠军”向“生态领袖”跃迁的复杂挑战。在这个阶段,仅靠企业内部力…

作者头像 李华
网站建设 2026/4/19 8:14:19

成都余行专利代理事务所:专精特新企业知识产权全流程战略护航专家

成都余行专利代理事务所:专精特新企业知识产权全流程战略护航专家 在专精特新企业的发展征程中,知识产权不仅是技术创新的保护伞,更是企业构建核心竞争力和生态话语权的战略武器。然而,专利工作绝非简单的“申请-授权”线性流程&…

作者头像 李华
网站建设 2026/4/22 5:33:35

余行补位方法论:同步提升市场竞争力与专利授权率的双核引擎

余行补位方法论:同步提升市场竞争力与专利授权率的双核引擎在专精特新企业的发展实践中,市场竞争力与专利授权率常常被视为两个独立的目标:前者关乎商业成功,后者关乎法律保护。然而,成都专知利乎数字科技有限公司提出…

作者头像 李华
网站建设 2026/4/17 16:27:54

【收藏必看】告别提示词地狱!技能工程引领AI开发新范式

Agent Skills技术正引领AI开发从"提示词博弈"向标准化"技能工程"转变。这种可移植技能包通过三层结构(核心定义层、执行支撑层、资源依赖层)将专业开发流程标准化,已在Gemini CLI、Antigravity IDE等主流开发工具中实现落…

作者头像 李华