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.
インストールする前に、エージェントに与えられる指示の中身を確認できます。
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.
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 → ./docsoutput_file → ./crisp-report.htmlExamples:
# 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.
#doc-id hash — shareable links to specific docsscripts/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.
| 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) |
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.
まだレビューはありません。使ってみた感想をお寄せください。
概要と使いどころ
CRISP Execute — Sprint execution loop with change request management, security gates, product gates, and stakeholder reporting. Use after Phase S (Spec) is complete and crisp-state.json shows ready_for_execute: true. Triggers on "start sprint", "begin build", "execute", "sprint 1", "run sprints", or when handed off from crisp-orchestrator.
日本語の概要は準備中です。原文の説明を表示しています。
CRISP session manager — detects project state and routes to the right entry point. Use /crisp to start or resume any CRISP engagement. Handles new projects (discovery), existing codebases (archaeology), active sprints (execute), and validation (prove). Reads docs/crisp-state.json to know where you are.
日本語の概要は準備中です。原文の説明を表示しています。
Begin a CRISP product discovery session — Phase C (Clarify)
日本語の概要は準備中です。原文の説明を表示しています。
The Mileva Method (CRISP) — Phase 1: Clarify. Problem definition, eliciting, painkiller test, buy vs build, AI justification gate, Go/No-Go. Use at the start of any AI implementation project. Triggers on "clarify", "phase 1", "start discovery", "define the problem", "what problem are we solving", or at the beginning of a new client engagement.
日本語の概要は準備中です。原文の説明を表示しています。
The Mileva Method (CRISP) — Phase 2: Results. Outcome alignment, stakeholder register, baseline measurement, success metrics, tradeoff negotiation. Use after problem definition is complete. Triggers on "results", "phase 2", "define success", "success metrics", "what does done look like", or after Phase C exit checklist is complete.
日本語の概要は準備中です。原文の説明を表示しています。
The Mileva Method (CRISP) — Phase 3: Investigate. Process mapping for existing or greenfield processes, user journey mapping, UX discovery, project goals, system architecture (integration map + data flow). Use after outcome alignment. Triggers on "investigate", "phase 3", "map the process", "process mapping", "user journey", "as-is process", or after Phase R exit checklist is complete.
日本語の概要は準備中です。原文の説明を表示しています。