进度报告(Progress Report)
报告是一种确定性投影。切勿为了维护报告而创建、保留、发送消息或轮询 agent。 仅记录缺失的任务分配、决策或阻塞项事实。
从仓库根目录运行 CLI:下文中的 progress 代表 python <技能目录>/scripts/progress.py
(目录位于 .claude/skills/progress-report、.agents/skills/progress-report 或 $CLAUDE_PLUGIN_ROOT/skills/progress-report)。
每次输入完整命令。动词输出单行(refresh 无输出;请原样传递输出)。
何时使用
- 计划文件(包含
- [ ]/- [x]项的 Markdown)驱动工作:计划模式,无需 Spec Kit。 - Spec Kit 功能包含
specs/<feature>/tasks.md:功能模式;当工作流文件存在时,会被收集。
计划模式快速入门
- 运行
progress hooks install --host claude(或codex;添加--scope user进行插件安装)一次,用于模型、工作量、上下文和子 agent。跳过此步骤,任务仍会被追踪。 progress init --plan docs/plan.md创建.progress/plan/目录(参见--name、--dir参数),并打印bind=<nonce>;下一个钩子将绑定(如果已存在报告,hooks install会打印一个绑定)。- 在计划文件中勾选完成项;报告会自动跟随。进度报告不会改写计划文件。
progress status显示单行状态;视图位于.progress/plan/.view/index.html。
具有显式 ID 的项保持其 ID(如 T001);其他项会获得稳定的 P001... 等 ID。当仅有一个计划或功能处于活动状态时,无需指定目标标志;否则需传递 --plan NAME 或 --feature DIR。
动词
| 需求 | 命令 |
|---|---|
| 创建报告 | progress init --plan PATH [--name N] [--dir D] 或 progress init(Spec Kit) |
| 单行状态 | progress status |
| 分配工作流 | progress lane L1 --tasks P001-P004 --owner ID --harness H --model M --effort E |
| 关闭工作流 | progress lane L1 --close |
| 设置阻塞项 | progress block P007 --by L2(或 P003、ext:"文本");progress unblock B4 |
| 记录决策 | progress decide ask "问题" --options a,b;progress decide made D2 b --by user |
| 添加备注 | progress note "文本" --target P005 |
| 导出报告 | progress export --format md |
| 管理钩子 | `progress hooks install |
规则
- 当你分配工作时,记录一条工作流(
L#;主机的子工作流C#会自动出现)。开始、完成和重试无需命令。 - 绝不要在备注中放入密钥、绝对路径或对话文本(备注最多 200 个字符)。
- 未知值保持未知。不要估算模型、工作量、上下文或时间。
- 错误输出为
progress: error CODE;修复原因,不要循环重试。
详细信息:references/verbs.md;合约 docs/contracts.md;标志 docs/commands.md。