Skip to content

prism report

Generate roadmap reports from a PRISM document.

Synopsis

prism report <file> [options]

Description

Generate a roadmap report in Markdown or JSON format. The report can be generated in different views:

  • by-phase: Phase → Goal → Initiative (timeline view)
  • by-goal: Goal → Phase → Initiative (strategic view)
  • both: Both views in a single document (default)

Options

Option Description
-o, --output <file> Output file (default: stdout)
-f, --format <format> Output format: markdown, json (default: markdown)
-v, --view <view> View type: both, by-phase, by-goal (default: both)
--title <title> Report title (default: from metadata)
--author <author> Report author (default: from metadata)
--no-meta Omit YAML front matter (Markdown only)
--no-detail Omit initiative details

Examples

Generate markdown report to stdout:

prism report roadmap.json

Generate markdown report to file:

prism report roadmap.json -o report.md

Generate JSON report:

prism report roadmap.json --format json

Generate phase-centric view only:

prism report roadmap.json --view by-phase

Generate goal-centric view only:

prism report roadmap.json --view by-goal

Generate report with custom title:

prism report roadmap.json --title "Q1 2026 Roadmap Report"

Output Format

Markdown Output

The markdown output includes:

  • YAML front matter (title, date, author)
  • Summary section with goal and phase counts
  • View sections (by-phase and/or by-goal)
  • Initiative details with status and deployment info

JSON Output

The JSON output includes a structured roadmap report object:

{
  "title": "Roadmap Report",
  "generatedAt": "2026-04-18T10:00:00Z",
  "summary": {
    "totalGoals": 2,
    "totalPhases": 4,
    "totalInitiatives": 8
  },
  "goals": [...],
  "phases": [...]
}

See Also