Правила OpenCode (AGENTS.md)

В OpenCode,Правила — это основной механизм управления поведением ИИ.。

Мы можем с помощьюAGENTS.mdфайла, предоставить OpenCode пользовательские инструкции, позволяя ему разрабатывать в соответствии со стандартами вашего проекта.

Инструменты определяют, что может делать ИИ; AGENTS.md определяет, как ИИ должен это делать.

AGENTS.md = Установка стандартов командной разработки для ИИ.

1. Что такое AGENTS.md

AGENTS.mdЭто файл правил, используемый для:

  • Определения структуры проекта
  • Обеспечения соблюдения стиля кода
  • Стандартизации рабочего процесса разработки
  • Руководства для ИИ по выполнению задач

Это содержимое будет добавлено в контекст LLM.

Эффекты:

  • ИИ лучше понимает ваш проект
  • Сгенерированный код лучше соответствует спецификациям
  • Сокращает повторные правки

2. Быстрая инициализация

Запустите в OpenCode:

/init

Эта команда:

  • Просканируйте структуру проекта
  • Проанализируйте организацию кода
  • Автоматически создайте AGENTS.md

Рекомендация:

  • Закоммитьте AGENTS.md в Git
  • Как единый командный стандарт

3. Пример структуры

# 项目说明

这是一个基于 TypeScript 的 monorepo 项目。

## 项目结构

- packages/ 核心模块
- infra/ 基础设施
- web/ 前端应用

## 代码规范

- 使用 TypeScript 严格模式
- 公共代码放在 packages/core
- 所有函数必须添加注释

## 开发约定

- 使用 workspace 方式引用模块
- API 必须统一错误处理

Суть: напишите командные стандарты "для AI, чтобы видеть"

4. Область применения правил

1. Правила уровня проекта

Путь:

./AGENTS.md

Эффект:

  • Применяется только к текущему проекту
  • Общие для команды

2. Глобальные правила

Путь:

~/.config/opencode/AGENTS.md

Эффект:

  • Применяется ко всем проектам
  • Личное использование

Рекомендуемые способы использования:

  • Личные привычки программирования
  • Управление стилем вывода

5. Совместимость с Claude Code

OpenCode совместим с системой правил Claude Code:

  • Правила проекта: CLAUDE.md
  • Глобальные правила: ~/.claude/CLAUDE.md
  • Каталог навыков: ~/.claude/skills/

Если вы не хотите это использовать, его можно отключить:

export OPENCODE_DISABLE_CLAUDE_CODE=1

6. Приоритет загрузки правил (важно)

OpenCode загружает правила при запуске в следующем порядке:

  1. Поиск AGENTS.md вверх от текущего каталога
  2. Если не найден → искать CLAUDE.md
  3. Глобальные правила ~/.config/opencode/AGENTS.md
  4. Глобальные правила Claude ~/.claude/CLAUDE.md

Ключевые моменты:

  • AGENTS.md имеет наивысший приоритет
  • На одном уровне используется только первый совпадающий файл

7. Расширенные правила (instructions)

Вы можетеopencode.jsonзагружать дополнительные файлы правил из:

{
  "instructions": [
    "CONTRIBUTING.md",
    "docs/guidelines.md",
    ".cursor/rules/*.md"
  ]
}

Преимущества:

  • Повторно использовать существующую документацию
  • Избегать дублирования сопровождения

Поддерживает удалённые правила

{
  "instructions": [
    "https://raw.githubusercontent.com/xxx/rules/main/style.md"
  ]
}

Примечание:

  • Поддерживается загрузка по URL
  • Тайм-аут: 5 секунд

8. Модульные правила (продвинутый уровень)

Рекомендуемый метод (с использованием инструкций)

{
  "instructions": [
    "docs/dev.md",
    "test/rules.md",
    "packages/*/AGENTS.md"
  ]
}

Подходит для:

  • monorepo
  • Большие проекты

Метод 2: Вручную сослаться в AGENTS.md

# 规则加载说明

当遇到 @xxx 文件时，请使用 read 工具加载。

- 不要一次性加载全部文件
- 按需加载
- 加载后必须遵守

Пример:

TypeScript 规范：@docs/typescript.md
React 规范：@docs/react.md
API 规范：@docs/api.md

Реализуйте «загрузку правил по требованию»

9. Лучшие практики (ключевые моменты)

1. Правила должны быть конкретными

❌ Не пишите:

The code should follow standard conventions.

✅ Вы должны написать:

所有函数必须添加 JSDoc 注释

2. Правила должны быть исполняемыми

ИИ может выполнять только явные правила, а не абстрактные описания.

3. Не делайте их слишком длинными

Рекомендация:

  • Записывайте основные правила в AGENTS.md
  • Выносите подробные правила в файлы инструкций

4. Поддерживаются командой единообразно

  • Поместите под управление Git
  • Как часть стандартов разработки
Другие расширения