跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.devinenterprise.com/llms.txt

Use this file to discover all available pages before exploring further.

规则是持续生效的指示，用于规定 Devin CLI 在你的项目中的行为方式。它们会在每次会话开始时注入到 Agent 的上下文中，确保整个团队的行为保持一致。 规则的常见用途包括编码标准、架构指南、偏好的库、测试规范以及项目特有的约束。 为了提升编码能力、加快完成速度并降低成本，我们强烈建议在可能的情况下优先使用 Skills。Skills 只有在相关时才会注入上下文。Rules 和 AGENTS 应尽可能保持精简。 我们推荐的做法是使用规则来引用模型应在特定场景下使用的 Skills。

​
AGENTS.md

添加规则最简单的方法，是在项目根目录中使用一个 AGENTS.md 文件： 
# Project Rules

- Use TypeScript for all new files
- Follow the existing patterns in src/components/
- Always run `npm run lint` before committing
- Use pnpm, not npm or yarn
- Write tests for all new utility functions
Devin CLI 会自动读取此文件。
AGENTS.md 是管理项目规则的推荐做法。它易于阅读、支持版本控制，并且适用于多种 AI 工具。

​
全局规则

你也可以在用户配置目录中放置一个 AGENTS.md 文件，创建适用于所有项目的规则： 
~/.config/devin/AGENTS.md
全局规则会在每次会话开始时加载，无论你当前在处理哪个项目。你可以用它们来设置在所有地方都生效的个人偏好： 
# My Global Rules

- Always write commit messages in conventional commit format
- Prefer functional patterns over imperative code
- Run tests before suggesting a task is complete
全局规则与项目规则会同时生效——两者会一并加载。此位置也支持 AGENT.md。
如果你使用 Claude Code，Devin CLI 也会将 ~/.claude/CLAUDE.md 作为全局规则读取。

​
支持的文件名

Devin CLI 会从以下任一文件中读取规则：
文件说明
AGENTS.md推荐
AGENT.md单数形式的替代名称
CLAUDE.md兼容 Claude Code
这些文件都会被一视同仁地处理——其内容都会作为始终生效的规则加载。 这些文件可以位于项目中的多个层级 (不只是根目录) 。工作区根目录中的文件会在会话开始时加载。子目录中的文件则会在 Agent 访问该目录中的文件时按需发现，从而让上下文聚焦于代码库中相关的部分。 你也可以将这些文件放在全局配置目录中，使其对所有项目生效，但 CLAUDE.md 除外；它会从 ~/.claude/CLAUDE.md 全局读取。

​
来自其他工具的规则

如果你是从其他 AI 编码工具迁移过来的，Devin CLI 可以读取你现有的规则：
Devin CLI 会读取 .cursorrules 和 .cursor/rules/*.md。Cursor 规则支持使用 frontmatter 控制激活方式：
---
description: "React component guidelines"
globs: "src/components/**/*.tsx"
alwaysApply: false
---

Use functional components with hooks. Never use class components.
激活行为：
  • alwaysApply: true — 始终激活
  • 指定了 globs — 处理匹配文件时激活
  • 只有 description — 由 Agent 决定何时应用
  • 以上都不满足 — 用户必须手动调用
Devin CLI 会读取 .windsurf/rules/*.md 和 .windsurf/global_rules.md。子目录支持： .windsurf/rules/ 目录可以存在于项目中的多个层级，而不只是在根目录。工作区根目录中的规则会在会话开始时加载。子目录中的规则会被延迟发现——当 Agent 访问该目录中的文件时，会自动加载在那里找到的任何 .windsurf/rules/ (以及父目录中直到工作区根目录的 .windsurf/rules/) 。这样可以避免项目中无关部分的规则污染 Agent 的上下文。Windsurf 规则支持 frontmatter：
---
description: "API design rules"
trigger: always_on
---

All API endpoints must return JSON with a consistent envelope format.
触发器值： always_on, manual, model_decision, agent, glob
Devin CLI 会读取 .claude/ 目录。
Devin CLI 不支持 .codeiumignore 文件。如果你使用 Codeium 的自动补全功能，并且已配置忽略模式，这些模式将不会对 Devin CLI 生效。

​
控制导入

你可以在配置文件 (~/.config/devin/config.json，或 Windows 上的 %APPDATA%\devin\config.json，或 .devin/config.json) 中启用或禁用读取特定工具格式的功能： 
{
  "read_config_from": {
    "cursor": true,
    "windsurf": true,
    "claude": true
  }
}
AGENTS.md 始终会被读取，且无法禁用。

​
规则激活类型

从外部格式加载的规则可能具有不同的激活方式：
类型行为
始终生效在每个会话中都处于激活状态，无需用户操作
Glob 激活当 Agent 处理与特定模式匹配的文件时激活
Agent 决定Agent 根据规则的描述来决定何时应用
用户可调用仅在用户明确触发时才会激活
来自 AGENTS.md 的规则始终为“始终生效”。

​
最佳实践

保持规则简洁

冗长的规则会分散 Agent 的注意力。只聚焦最重要的内容。

具体明确

“使用 pnpm”比“使用合适的包管理器”更好。具体的指示更容易遵循。

包含示例

展示你想要的模式，而不只是描述它。

纳入版本控制

将规则保存在你的 repo 中，这样整个团队都能遵循同一套准则。
对于大多数常见类型的规则，建议改用 skills。skills 能让你更灵活地控制它们何时以及如何生效。