agentic-report documentation

Build the page, not a frontend project

agentic-report turns Markdown, compact metadata, confined partials, and local assets into a polished interactive HTML page. The default is one self-contained file; directory output keeps the same behavior with content-addressed assets.

Start here

Use Node.js 24.18.0 or newer. Start with the agent quickstart, retrieve the direct Markdown version, or install the agent skill.

Authoring contract

Authors write declarative source rather than application code. Use Markdown for content, frontmatter or a manifest for page settings, allowlisted semantic directives for components, confined Markdown partials for composition, and local assets for media and downloads.

Agent reference

Commands, JSON output, starters, components, layouts, themes, diagnostics, and output behavior.

Read the reference

Source contract

The authoritative syntax, confinement boundary, output modes, and security model.

Read the source contract

Live discovery

Run describe --json, schema, and examples --json against the installed release for machine-readable runtime truth.

Output and operation

  • single-file is the default: one portable HTML file with embedded local resources and runtime.
  • directory writes index.html plus content-hashed resources for larger pages.
  • Both formats open through normal file:// and preserve the same supported interactions.
  • The compiler neither hosts nor deploys the result and never fetches remote source.

The public landing, incident review, vendor decision, and launch readiness page are all built through this same contract.

Release identity

release.json records the package version, source revision, and hashes for the exact staged files. The hosted site is accepted only after ordinary trusted HTTPS, real route/MIME checks, and a real 404 prove that a static host is not serving a catch-all shell.