Skip to content
Apothem

编写与流水线操作指南

面向任务的演练:将内容精炼为规格、生成计划套件、评审计划、执行阶段、添加工件,以及运行质量闸门。

面向任务的演练,用于 编写 Apothem 工件并驱动计划流水线。每篇指南只回答一个具体问题。

关于首次运行的设置方案 —— 添加工具、编辑配置档案、驱动安装器 —— 请改看 操作指南 章节。

计划套件流水线

如何将原始内容精炼为规格?

以原始内容作为输入调用 /plan-spec。Forge 角色会运行六个转换阶段(发现、细致考量、效力映射、保留验证、专长应用、问题求解扫描),并在 .apothem/plans/{suite}/_spec/spec.md 产出整合后的规格。完整协议参见 src/apothem/commands/plan-spec.md。

如何从规格生成计划套件?

在 /plan-spec 写出规格之后,调用 /plan-generate .apothem/plans/{suite}/_spec/spec.md。生成器会产出规范的基础设施文件,以及每个阶段的 phases/NN-kebab-topic/PHASE.md 文件。参见 src/apothem/commands/plan-generate.md。

如何审查已生成的计划?

调用 /plan-review path/to/plan-suite/。审查者会应用九项规划技法并产出记分卡。在 SHARED+ 层级,未通过的记分卡会阻断执行,直至问题解决。参见 src/apothem/commands/plan-review.md。

如何执行计划?

调用 /plan-execute path/to/plan-suite/ [phase-id]。不带 phase-id 时,运行下一个待处理的阶段;带特定 id 时,仅运行该阶段。参见 src/apothem/commands/plan-execute.md。

如何检查计划状态?

调用 /plan-status path/to/plan-suite/ [--verbose]。这是只读报告。参见 src/apothem/commands/plan-status.md。

编写工件

如何添加新规则?

  1. 在 src/apothem/rules/ 下选取一个 kebab-case 文件名,例如 src/apothem/rules/my-new-rule.md。
  2. 编写前置元数据(name、description、pathFilter、alwaysApply)。
  3. 用规范章节撰写正文:Purpose、Obligations、Seriousness Scaling、Anti-Patterns、Enforcement、Bindings。
  4. 运行 python scripts/dev/validate_ecosystem.py --check frontmatter-cohort 进行验证。

规则加载器基于 glob 工作,会收录匹配 src/apothem/rules/*.md 的每个文件,因此无需注册表条目;只需将规范命名的文件放入该目录,即完成注册。

如何添加新的委派工作者?

在下方所示的目录下选取一个 kebab-case 文件名,格式为 my-worker.md:

src/apothem/agents/
src/apothem/agents/my-worker.md

然后:

  1. 编写前置元数据——包括 name、version、updated、description、tools、disallowedTools、maxTurns 以及 effort。

  2. 将系统提示词作为正文编写。

委派工作者集合通过 glob 从 src/apothem/agents/*.md 加载,因此规范命名的文件一经放置即被收录——无需编辑任何注册表。

如何添加新钩子?

  1. 在 src/apothem/hooks/messages/<event>-<scope>.md 下编写一条上下文消息。
  2. 在 settings.json 中接入该钩子。
  3. 更新钩子流水线。
  4. 运行 python scripts/dev/validate_ecosystem.py。

质量闸门

如何运行本地质量闸门?

python -m ruff check .
python -m ruff format --check .
python -m mypy
python -m pytest -q
python scripts/dev/validate_ecosystem.py
python scripts/dev/chaos_pass.py

CI 流水线会并行运行同一组命令。

如何检查单个工件类的前置元数据?

python scripts/dev/validate_ecosystem.py --check frontmatter-cohort

On this page