html-report

Generate self-contained HTML investigation reports from a JSON spec with provenance and run metadata.

Updated Jul 4, 2025
One-click install
npx skills add https://github.com/milespossing/nixdots --skill html-report-milespossing
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: html-report
Source: https://github.com/milespossing/nixdots/tree/main/modules/agents/_skills/html-report
Command: npx skills add https://github.com/milespossing/nixdots --skill html-report-milespossing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve? Long investigations, code reviews, and multi-source research lose structure and traceability when pasted as markdown in chat. This Skill turns an analytical result into a single self-contained index.html with a mandatory executive summary, cited findings, drilldown evidence, and a run-metadata appendix. ## Core Features & Use Cases - Structured report contract: Every report includes an executive summary (question, context, findings, confidence), optional recommendations / open questions / out-of-scope sections, and an appendix recording model, prompt, tools, and sources. - Rich block catalog: Typed blocks for tables (sortable), code with syntax highlighting, diffs, key-value lists, collapsible drilldowns, figures, and Vega-Lite charts, all inlined into one portable HTML file. - Deep provenance: Findings link via stable src- ids to URLs, file:line references, PRs, commits, and screenshots listed in the appendix. - Use Case: After investigating why p99 write latency spiked in a service, ask for an HTML report; the Skill assembles findings, traces, diffs, and benchmark tables into ~/reports/<slug>-<ts>/index.html and optionally opens it in your browser. ## Quick Start Investigate the recent latency spike in the order service and write the results up as an HTML report with cited sources and a confidence rating.

Frequently Asked Questions about html-report

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an HTML report from an investigation?▼

Write a JSON spec describing the title, slug, executive summary, sections, and meta sources, then run node scripts/build.mjs <spec.json> --open. The script writes a self-contained index.html under ~/reports/<slug>-<timestamp>/ and optionally opens it in your browser.

What content blocks can an HTML report include?▼

The renderer supports paragraphs, lists, syntax-highlighted code, unified diffs, sortable tables, key-value lists, collapsible details drilldowns, figures with inline SVG or images, Vega-Lite charts, and callouts. Raw HTML is available as an escape hatch but typed blocks are preferred.

Does the generated HTML report work offline?▼

Yes, CSS, JavaScript, and highlight.js language grammars are inlined into index.html, so reports render offline. The exception is Vega-Lite charts, which load Vega libraries from jsDelivr at view time and need network access only when viewing those charts.

What are the requirements to run the html-report build script?▼

The build script requires Node.js 18 or later on PATH and has no npm dependencies. Opening reports uses wsl-open on WSL or xdg-open on native Linux, and serving the reports directory uses Java's bundled jwebserver.

When should I not use an HTML report for output?▼

Skip HTML for quick chat answers, single-file edits, commit messages, PR descriptions, or short summaries destined for Slack or email, where markdown is more appropriate. The Skill fires only when the user explicitly requests HTML output with enough scope to justify it.