Community研究与数据分析github.com

samykabu/progress-report

为 Markdown 计划清单或 Spec Kit 功能维护实时、确定的进度报告。从计划文件、Claude Code 或 Codex 的钩子事件以及您记录的任务状态、阻塞项和决策事实中收集数据,然后生成浏览器视图和 Markdown 导出,无需消耗 agent 资源进行维护。

progress-report 是什么?

Progress Report 是一个零消耗、确定性驱动的进度追踪工具,专为使用 Markdown 计划清单(`- [ ]` / `- [x]`)或 Spec Kit 功能的开发工作流设计。它通过分析计划文件中的任务状态、监听 Claude Code 或 Codex 的钩子事件(如模型选择、工作流状态),并结合用户手动记录的任务分配、阻塞项和决策事实,自动生成一个实时的进度报告。该报告以单行状态、浏览器可查看的 HTML 页面以及 Markdown 导出文件的形式呈现,无需额外维护 agent 或轮询。 此工具的核心优势在于其“确定性”原则:它仅从中性事实(如计划文件状态、钩子事件和用户记录)中投影出报告状态,绝不涉及 agent 消息、轮询或额外的 agent 开销。它支持“计划模式”(基于独立计划文件)和“功能模式”(基于 Spec Kit 的 `specs/<feature>/tasks.md` 文件),并提供了强大的 CLI 命令来管理任务分配、阻塞项、决策记录和钩子安装。对于多计划或多功能场景,可通过 `--plan` 或 `--feature` 标志明确目标。 支持的平台包括 Claude Code 和 Codex。用户只需在项目根目录下运行 `progress` 命令(可通过 `python <技能目录>/scripts/progress.py` 调用),即可完成初始化、状态查询、任务分配等操作。钩子命令 `progress hooks install --host claude|codex` 可安装监听器,自动捕获 agent 行为并更新报告,无需手动干预。

兼容平台✓Claude Code✓Codex CLI~Cursor
npx skills add https://github.com/samykabu/sanduq-skills/tree/HEAD/skills/agent-tools/skills/progress-report

Installed? Explore more 研究与数据分析 skills: affaan-m/uspto-database, affaan-m/scholar-evaluation, affaan-m/literature-review · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

进度报告(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:功能模式;当工作流文件存在时,会被收集。

计划模式快速入门

  1. 运行 progress hooks install --host claude(或 codex;添加 --scope user 进行插件安装)一次,用于模型、工作量、上下文和子 agent。跳过此步骤,任务仍会被追踪。
  2. progress init --plan docs/plan.md 创建 .progress/plan/ 目录(参见 --name、--dir 参数),并打印 bind=<nonce>;下一个钩子将绑定(如果已存在报告,hooks install 会打印一个绑定)。
  3. 在计划文件中勾选完成项;报告会自动跟随。进度报告不会改写计划文件。
  4. 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

规则

  1. 当你分配工作时,记录一条工作流(L#;主机的子工作流 C# 会自动出现)。开始、完成和重试无需命令。
  2. 绝不要在备注中放入密钥、绝对路径或对话文本(备注最多 200 个字符)。
  3. 未知值保持未知。不要估算模型、工作量、上下文或时间。
  4. 错误输出为 progress: error CODE;修复原因,不要循环重试。

详细信息:references/verbs.md;合约 docs/contracts.md;标志 docs/commands.md。

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

samykabu/delegate-task

Delegate a task to an external agent CLI harness — Claude Code, OpenAI Codex, OpenCode, GitHub Copilot, or Pi — and get back a normalised result with status (successful / failed / abandoned), a summary, what actually changed on disk measured against git, and total input and output token usage.

samykabu/github-wiki-publish

Publish or update pages, reports, diagrams and assets in a GitHub repository Wiki, preserving existing content and verifying the published result. Use for GitHub Wiki publishing or sync requests, rather than GitHub Pages deployment or general documentation generation.

samykabu/illustrate

Draws diagrams, charts, and technical illustrations (44 types) as self-contained HTML with inline SVG, plus optional SVG/PNG/PDF export, in the project's tracked color and font theme. Use this skill whenever the user asks to draw, diagram, visualize, chart, map, sketch, or illustrate something, even without saying 'illustrate': architecture or system design, infrastructure, cloud or deployment topology, data flow, flowcharts, sequence, state machines, ER or database schema, UML class, dependency graphs, org charts, timelines, Gantt, swimlanes, process or workflow maps, user journeys, kanban, story maps, quadrants, Venn, pyramids, fishbone root-cause, Sankey, Wardley maps, bar, line, scatter, heatmap, waterfall, treemap, radar, or polar charts, and exploded or axonometric views. Also use to redraw .drawio, Mermaid (.mmd), or .excalidraw files, add a diagram to docs, a PR, or a spec, set up the illustration theme, or export a diagram. Not for photos or AI-generated raster images.

samykabu/user-manual

Create, update, audit and publish a standalone application User Manual with End User, Administrator and Technical editions, in English and optional Arabic. Use without Spec Kit to start a manual, document a feature or module, audit coverage, write API documentation (OpenAPI, AsyncAPI, GraphQL, webhooks), release notes and migration guides, plan and capture UI screenshots, set up private previews and versioned release…

相关技能