Loading...
Loading...
Generate human-readable report from Intent files. Converts technical Intent specs into readable documents for stakeholders, team members, or documentation. Supports multiple output formats.
npx skill4agent add arcblock/idd intent-report/intent-report [options]
↓
┌───────────────────────────────────┐
│ Read Intent files │
│ - Project-level + Module-level │
│ - Parse structure and metadata │
└─────────────┬─────────────────────┘
↓
┌───────────────────────────────────┐
│ Determine report type │
│ - overview / architecture / │
│ progress / full │
└─────────────┬─────────────────────┘
↓
┌───────────────────────────────────┐
│ Generate report │
│ - Restructure content │
│ - Translate technical language │
│ - Add visualizations │
└─────────────┬─────────────────────┘
↓
┌───────────────────────────────────┐
│ Output │
│ - Markdown / HTML / PDF │
│ - Write to file or display directly │
└───────────────────────────────────┘/intent-report --type overview# [Project] Overview
## What is this?
[One-sentence description]
## Problem
[Problem to solve]
## Solution
[Solution overview]
## Architecture
[Simplified architecture diagram]
## Key Modules
| Module | Purpose |
|--------|---------|
## Status
[Current status and next steps]/intent-report --type architecture# [Project] Architecture
## System Overview
[Architecture diagram]
## Module Dependencies
[Dependency diagram]
## Data Flow
[Data flow diagram]
## Key Design Decisions
| Decision | Choice | Rationale |
## Boundary Rules
[Module boundary rules]
## API Reference
[Core API list]/intent-report --type progress# [Project] Progress Report
> Generated: YYYY-MM-DD
## Intent Coverage
[Coverage chart]
## Module Status
| Module | Intent | Impl | Status |
|--------|--------|------|--------|
| core | ✓ | 80% | 🟡 |
## Recent Updates
[Recent Intent changes]
## Approval Status
- Locked: N sections
- Reviewed: M sections
- Draft: K sections
## Blockers & Risks
[Risks and blockers]
## Next Steps
[Next steps]/intent-report --type full/intent-report -o report.md/intent-report --format html -o report.html/intent-report/intent-report --type overview/intent-report --type architecture -o docs/ARCHITECTURE.md/intent-report --type progress -o reports/progress-2026-01.md/intent-report src/core/ --type full| In Intent | In Report |
|---|---|
| "What this module does" |
| "Out of scope" |
| "Constraints & Rules" |
| "Core Architecture (frozen)" |
| "Approved Design" |
| "Work in Progress" |
--mermaid/intent-init # Initialize
↓
/intent-interview # Create Intent
↓
/intent-review # Approve
↓
/intent-report # ← Generate report (this command)
↓
Share with stakeholders / team/intent-report
--type <type> # overview | architecture | progress | full
--format <format> # markdown | html
--output <path> # Output file path
--module <path> # Specify module
--include-draft # Include draft sections
--mermaid # Convert to Mermaid diagrams
--lang <lang> # Output language (en | zh)