用途
inscribe 用于捕获编码规范、规则或最佳实践,并将其持久化写入相应的文档文件中,以便在后续会话中被记住。当用户说出“inscribe”“learn”“remember this rule”“add…”等指令时触发。
主要能力
- 支持两种作用域:
- project(默认):约定作用于当前项目,自动发现目标文档文件。
- global:约定作用于该用户的所有项目,写入用户级全局指令文件。
- 支持多种输入来源:
- 显式参数:直接传入的规则或指南(例如 /inscribe always use named exports)。
- 对话上下文:从之前对话中讨论、纠正或确立的规则与模式中提取。
- 两者结合:参数引用或补充对话上下文。
- 项目级作用域下会自动扫描并发现可能存放约定的文档文件,包括:
- **/AGENTS.md
- **/CLAUDE.md
- */code-style.md
- */coding-style.md
- */conventions.md
- */guidelines.md
- docs/**/*.md
- .claude/skills/*/SKILL.md
- .opencode/skills/*/SKILL.md
- 若未发现任何文档文件,回退优先级为:项目根目录的 AGENTS.md(不存在则创建),其次为项目根目录的 CLAUDE.md(不存在则创建)。
- 全局作用域下按顺序查找并使用第一个存在的文件:
- ~/.claude/AGENTS.md
- ~/.claude/CLAUDE.md
- ~/.config/opencode/AGENTS.md
- ~/.codex/AGENTS.md
- 若均不存在,则检查存在哪些 agent 工具目录(~/.claude/、~/.config/opencode/、~/.codex/),并在找到的第一个目录中创建 AGENTS.md。
使用方式
命令格式:
/inscribe [scope] [guideline]
- scope(可选):project(默认)或 global。
- guideline(可选):若省略,则从最近的对话上下文中提取约定。
示例:
- /inscribe always use named exports in TypeScript
- /inscribe global never use console.log in production code
- /inscribe project use SnapKit for all layout constraints
- /inscribe all API response types must use Zod schemas
- /inscribe global 所有项目都要用 AGENTS.md 作为主指令文件
- /inscribe
工作流程
- 步骤 0:识别要学习的内容。若提供了 guideline 参数则以其为主要输入;若无参数则回顾最近对话中的规则、约定或模式并总结;若两者都有则结合。随后向用户展示识别出的约定并请求确认或修改。
- 步骤 1:发现目标文件(仅项目作用域)。扫描项目以查找可能存放约定的现有文档文件,构建目标表并按作用域(语言、框架、平台、项目级、技能)分类。技能文件(SKILL.md)使用目录名或 frontmatter 中的技能名。
- 步骤 2:选择目标文件(仅项目作用域)。向用户展示发现的文件及其推断作用域,用户可从列表中选择、指定新路径(技能会创建该文件),或接受自动建议。自动建议规则:语言/框架特定约定匹配对应语言的文件;技能特定约定匹配相关 SKILL.md;项目级规则匹配 AGENTS.md 或根级约定文件;AI 行为指令匹配 AGENTS.md 或 CLAUDE.md。
- 步骤 3:检查重复。读取目标文件并搜索是否已有覆盖同一主题的规则。若存在类似约定,提醒用户并询问:更新现有、并列添加或跳过。
- 步骤 4:起草新增内容。按照目标文件现有格式撰写新的约定条目:code-style 文件沿用现有章节模式(标题层级、带好坏标记的代码示例、说明);AGENTS.md / CLAUDE.md 沿用现有项目符号/章节风格;新文件使用简单的标题加项目符号列表格式。展示草稿(目标文件、章节、内容)并询问:添加、先编辑或取消。
- 步骤 5:写入并确认。将约定添加到目标文件的合适章节,打印包含文件路径、章节和摘要的确认信息,并询问是否提交。未经用户明确确认不得提交,提交信息使用 docs: inscribe <简要摘要>。
防护规则
- 写入前始终与用户确认究竟要学习什么。
- 绝不重复已有规则——检查目标文件中是否已存在该约定。
- 追加到合适的章节,若无合适章节则创建新章节。
- 保留每个目标文件现有的格式与风格。
- 写入前展示拟新增内容及目标文件。
适用场景
- 将对话中确立的编码规范固化到项目文档中。
- 为特定语言、框架或技能维护约定文件。
- 将跨项目的通用规则写入全局 agent 指令文件。
限制
- 全局作用域下跳过步骤 1–2(项目文件发现与选择)。
- 提交操作需用户明确确认,不会自动提交。
- 关于收费、价格、平台支持范围等信息,资料中暂未提供。