Get the FREE Ultimate OpenClaw Setup Guide →

report

npx machina-cli add skill lemon-etvibe/prompt-vault/report --openclaw
Files (1)
SKILL.md
2.0 KB

Parse phase log data and generate visualized HTML reports.

Arguments

  • summary — Generate summary dashboard only
  • detail — Generate detailed chat log view only
  • all (default) — Generate both
  • custom — Claude generates a custom report based on user request

Procedure

Standard Reports (summary / detail / all)

  1. Execute ${CLAUDE_PLUGIN_ROOT}/scripts/generate-report.sh:

    bash "${CLAUDE_PLUGIN_ROOT}/scripts/generate-report.sh" [summary|detail|all]
    
  2. Inform the user of generated file paths:

    • .local/logs/report-summary.html — Project summary dashboard
    • .local/logs/report-detail.html — Phase-by-phase detailed chat log
  3. Guide how to open in browser:

    open .local/logs/report-summary.html   # macOS
    xdg-open .local/logs/report-detail.html # Linux
    

Custom Reports (custom)

  1. First generate standard reports (same procedure as above).
  2. Confirm the user's additional requests (e.g., "add retrospective section", "apply specific palette").
  3. Read the generated HTML files and modify/enhance per user request.
  4. Save modified files and inform the user of paths.

Data Sources

Reference the following data when generating reports:

  • Project metadata: .local/logs/.configproject_name, project_description, palette
  • Phase index: .local/logs/_index.md — phase list table
  • Phase details: .local/logs/phase-*.md — prompts, actions, results, decisions, next steps per phase
  • Additional context (if available): package.json, CLAUDE.md

Error Handling

  • .local/logs/ does not exist → Guide user to run /prompt-vault:init
  • _index.md missing → Generate empty report with warning message
  • phase-*.md non-standard format → Display parseable parts only, leave rest empty
  • .config missing → Use defaults (project directory name, default palette)

Source

git clone https://github.com/lemon-etvibe/prompt-vault/blob/main/skills/report/SKILL.mdView on GitHub

Overview

Parses phase log data and generates visualized HTML reports. It produces a project-wide summary dashboard and a detailed phase view, helping teams quickly review progress, decisions, and next steps.

How This Skill Works

It runs the generate-report.sh script with a mode argument (summary, detail, all, or custom). The script reads data from the local logs (such as .local/logs/_index.md and phase-*.md) and writes HTML files like report-summary.html and report-detail.html, which can be opened in a browser.

When to Use It

  • You need a quick project summary dashboard for stakeholders (summary).
  • You want a detailed, phase-by-phase chat log view (detail).
  • You must deliver both summary and detail reports (all).
  • You require a custom report adjusted to user requests (custom).
  • You want browser-ready HTML reports to share or present (share).

Quick Start

  1. Step 1: Run the generator with a mode, e.g., bash "${CLAUDE_PLUGIN_ROOT}/scripts/generate-report.sh" [summary|detail|all]
  2. Step 2: Note generated files, such as .local/logs/report-summary.html and .local/logs/report-detail.html
  3. Step 3: Open in a browser (macOS: open .local/logs/report-summary.html; Linux: xdg-open .local/logs/report-detail.html)

Best Practices

  • Run standard reports before attempting custom edits to ensure core content is present.
  • Keep data sources up-to-date: .local/logs/.config, _index.md, and phase-*.md for accurate visuals.
  • Specify a consistent palette in project metadata (.local/logs/.config) to maintain branding.
  • Check prerequisites: ensure .local/logs/ exists; initialize with /prompt-vault:init if missing.
  • Test the generated HTML in your target OS browser (macOS/Linux) using the appropriate open/xdg-open commands.

Example Use Cases

  • Generate report-summary.html and report-detail.html, then open both in the browser for stakeholder review.
  • Create a custom report by adding a retrospective section and applying a specific color palette.
  • If _index.md is missing, generate an empty report with a warning message to indicate gaps.
  • Update project metadata (e.g., new palette) and re-run to refresh visuals across reports.
  • Share the HTML reports with teammates by providing the file paths or exporting the HTML files.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers