Project notes
Dossier
A self-contained, interactive HTML document format for planning, documenting, and deciding with AI.
Repository snapshot
- 102Commits
- Jul 2026Updated in snapshot
- MITLicense
- Jun 2026Started
- JavaScript 89.7%
- TypeScript 10.3%
Recent commits
Overview
Dossier turns an agent-authored JSON document model into one polished, self-contained HTML file plus Markdown. It is built for plans, specs, research, review boards, runbooks, and decision documents that humans can navigate, search, mark up, edit in place, export, and hand back to an agent without losing structure.
Highlights
- 01
Single-file output
Builds offline HTML with inlined styles, runtime, diagrams, code highlighting, and the source model embedded as an agent-readable data island.
- 02
Human and agent loop
Review-board blocks let a human choose options and add notes, then export decisions JSON that an agent can read back cleanly.
- 03
CLI and MCP
Ships a Node CLI plus an MCP server with render, validate, schema, starter, catalog, and decision-reading tools for agent workflows.
- 04
Document contract
Uses a JSON schema and reusable block model covering hero sections, tables, code, diagrams, charts, risks, action items, reviews, receipts, and more.
- 05
Renderer parity
Includes the zero-runtime Node generator and a typed React renderer for teams that want live components or SSR integration.
- 06
Agent skill included
Bundles a Claude Code skill, block cheatsheet, and starter template so agents can author dossiers directly.
What you can build
Documentation & getting started
npm install -g github:kylebegeman/dossier
dossier init my-doc
dossier build my-doc.dossier.json
open my-doc.html
- Live demoEvery block type in one self-contained Dossier.
- READMEHow Dossier works and how to use it from an agent.
- SchemaThe JSON document contract for generated dossiers.
- Agent skillClaude Code skill and references for authoring dossiers.
- React rendererTyped React and TSX rendering for app integrations.
- Design notesDesign system and product decisions.