speckit-report

Renders completion-report.md and testing.md into one self-contained HTML review page.

Updated Jul 8, 2026
One-click install
npx skills add https://github.com/NarenKarthikBM/specseyal --skill speckit-report-narenkarthikbm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: speckit-report
Source: https://github.com/NarenKarthikBM/specseyal/tree/main/.claude/skills/speckit-report
Command: npx skills add https://github.com/NarenKarthikBM/specseyal --skill speckit-report-narenkarthikbm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After a spec-driven feature pipeline finishes, its completion report and testing record sit as separate Markdown files that are awkward to review together. This Skill turns them into a single self-contained HTML page for human review, without any model re-authoring the records. ## Core Features & Use Cases - Deterministic HTML rendering: Shells out to report.py to assemble one self-contained, untracked HTML page from completion-report.md and testing.md, with no network references or external assets. - Freshness checking: The --check flag compares an existing page against its sources and reports fresh (exit 0) or stale (exit 3), naming every changed source. - Strict refusal on bad input: Refuses to render (exit 2) if completion-report.md is absent or non-conforming, so a partial page never looks complete; a missing testing.md is not an error. - Use Case: After a feature's implementation and testing phases finish, invoke the skill to produce a single reviewable HTML page, or run it with --check later to confirm the page still matches the underlying records. ## Quick Start Ask the assistant to render the review report for the current feature, optionally passing a feature directory, --check, or --out path which is forwarded verbatim to report.py.

Frequently Asked Questions about speckit-report

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I render a completion report as an HTML page?

Invoke the skill with no arguments and it runs report.py, which resolves the feature directory from .specify/feature.json and writes a self-contained HTML page. Pass a feature directory or --out path to override the defaults.

How do I check if a rendered report is stale?

Run the skill with the --check flag. report.py compares the existing page against its sources and exits 0 if fresh or 3 if stale, naming every changed source without writing anything.

What happens if testing.md is missing when rendering the report?

A missing testing.md is not an error. The page renders the completion half in full and states the absence of the coverage half plainly with zero coverage rows.

Why does report rendering fail with exit code 2?

Exit code 2 means completion-report.md is absent or does not conform to the completion-report contract, so the render is refused. This prevents a partial page from appearing complete.

Does the report skill use an AI model to write the HTML?

No. The skill is fully deterministic and model-free: it only invokes report.py and relays its output, never reading or re-authoring the completion or testing records itself.