How do I install the Crisp Report skill?

Run npx skillmds add majiayu000/crisp-report in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Crisp Report safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: makes network calls. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Crisp Report?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Crisp Report free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Crisp Report?

majiayu000 (@majiayu000) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Crisp Report by majiayu000 — Agent Skill

Name: Crisp Report
Rating: 4.666666666666667 (3 reviews)
Author: majiayu000

Crisp Report

Generate a beautiful single-file HTML report from the project's docs/ folder. Works after any CRISP phase, after Archaeology, or at sprint close in Execute. Triggers on "generate report", "export docs", "create HTML report", "share docs", or automatically at sprint close in CRISP Execute.

majiayu000 0080528 2 files · 4.7 KB Updated Sep 9, 2026 567 repo stars

File contents

CRISP Report Generator

Converts all markdown files in docs/ into a single self-contained HTML file — cards overview, click-through to full documents, beautiful dark theme, no dependencies.

How to run

Step 1: Check dependencies

pip3 install markdown pygments

If pip3 isn't available, try: python3 -m pip install markdown pygments

Step 2: Run the script

python3 scripts/generate-report.py [docs_dir] [output_file]

Defaults:

docs_dir → ./docs
output_file → ./crisp-report.html

Examples:

# Default — reads ./docs, outputs ./crisp-report.html
python3 scripts/generate-report.py

# Custom paths
python3 scripts/generate-report.py ./docs ./reports/sprint-3-report.html

Step 3: Open

open crisp-report.html

Or share the file directly — it's fully self-contained. No server needed.

What it produces

Overview page — card grid, one card per document, grouped by section (Discovery / Spec / Archaeology / Execute)
Document pages — click any card → full rendered document with proper typography, code highlighting, tables
Escape / Back → returns to overview
Direct URL linking via #doc-id hash — shareable links to specific docs

When to run

End of CRISP Phase S — before handing off to Execute. Share with stakeholders for review.
End of each sprint — updated report alongside the sprint delta doc. The stakeholder report section is already in the HTML.
After CRISP Archaeology — share the recovered docs with the client or team.
Any time — "generate report" at any point in a CRISP session.

Script location

scripts/generate-report.py in the project root (copied from the CRISP repo).

If the script doesn't exist in the project yet, instruct the user to copy it from the CRISP repo:

curl -o scripts/generate-report.py https://raw.githubusercontent.com/radekamirko/C.R.I.S.P/main/scripts/generate-report.py

Or copy it manually from C.R.I.S.P/scripts/generate-report.py.

Output file naming convention

When	Suggested name
Phase S complete	`crisp-report.html`
Sprint N close	`crisp-report-sprint-N.html`
Archaeology complete	`crisp-report-archaeology.html`
Ad hoc	`crisp-report.html` (overwrites)

Troubleshooting

ModuleNotFoundError: No module named 'markdown' → Run: pip3 install markdown pygments --break-system-packages

No markdown files found in docs/ → Make sure you're running from the project root, or pass the correct path: python3 scripts/generate-report.py ./path/to/docs

Docs are blank or broken → Check that docs are valid UTF-8 markdown. The script skips files it can't read.

---name: crisp-reportdescription: Generate a beautiful single-file HTML report from the project's docs/ folder. Works after any CRISP phase, after Archaeology, or at sprint close in Execute. Triggers on "generate report", "export docs", "create HTML report", "share docs", or automatically at sprint close in CRISP Execute.--- # CRISP Report Generator Converts all markdown files in `docs/` into a single self-contained HTML file — cards overview, click-through to full documents, beautiful dark theme, no dependencies. --- ## How to run **Step 1: Check dependencies** ```bash pip3 install markdown pygments ``` If pip3 isn't available, try: `python3 -m pip install markdown pygments` **Step 2: Run the script** ```bash python3 scripts/generate-report.py [docs_dir] [output_file] ``` Defaults: - `docs_dir` → `./docs` - `output_file` → `./crisp-report.html` Examples: ```bash # Default — reads ./docs, outputs ./crisp-report.html python3 scripts/generate-report.py # Custom paths python3 scripts/generate-report.py ./docs ./reports/sprint-3-report.html ``` **Step 3: Open** ```bash open crisp-report.html ``` Or share the file directly — it's fully self-contained. No server needed. --- ## What it produces - **Overview page** — card grid, one card per document, grouped by section (Discovery / Spec / Archaeology / Execute) - **Document pages** — click any card → full rendered document with proper typography, code highlighting, tables - **Escape / Back** → returns to overview - Direct URL linking via `#doc-id` hash — shareable links to specific docs --- ## When to run - **End of CRISP Phase S** — before handing off to Execute. Share with stakeholders for review. - **End of each sprint** — updated report alongside the sprint delta doc. The stakeholder report section is already in the HTML. - **After CRISP Archaeology** — share the recovered docs with the client or team. - **Any time** — "generate report" at any point in a CRISP session. --- ## Script location `scripts/generate-report.py` in the project root (copied from the CRISP repo). If the script doesn't exist in the project yet, instruct the user to copy it from the CRISP repo: ```bash curl -o scripts/generate-report.py https://raw.githubusercontent.com/radekamirko/C.R.I.S.P/main/scripts/generate-report.py ``` Or copy it manually from `C.R.I.S.P/scripts/generate-report.py`. --- ## Output file naming convention | When | Suggested name | |---|---| | Phase S complete | `crisp-report.html` | | Sprint N close | `crisp-report-sprint-N.html` | | Archaeology complete | `crisp-report-archaeology.html` | | Ad hoc | `crisp-report.html` (overwrites) | --- ## Troubleshooting **`ModuleNotFoundError: No module named 'markdown'`** → Run: `pip3 install markdown pygments --break-system-packages` **`No markdown files found in docs/`** → Make sure you're running from the project root, or pass the correct path: `python3 scripts/generate-report.py ./path/to/docs` **Docs are blank or broken** → Check that docs are valid UTF-8 markdown. The script skips files it can't read.

Frequently asked questions