Agent quickstart

Agent quickstart

Use Node.js 24.18.0 or newer. The first npx command needs npm registry and network access; the generated page itself opens locally through file:// with its included package-owned browser runtime.

For a reproducible 0.2.0 run, create a new landing-page source and keep the package version pinned through validation, inspection, and build:

npx --yes agentic-report@0.2.0 init ./my-page --starter landing --json
npx --yes agentic-report@0.2.0 validate ./my-page --json
npx --yes agentic-report@0.2.0 inspect ./my-page --json
npx --yes agentic-report@0.2.0 build ./my-page --output ./my-page.html --json

Open my-page.html through file://. Edit only the declarative source: Markdown, YAML frontmatter or the optional YAML/JSON manifest, confined Markdown partials, and local assets. Authors do not need React, JSX, browser JavaScript, CSS, or a frontend project.

The shorter current-channel journey is:

npx --yes agentic-report init ./my-page --starter landing --json
npx --yes agentic-report validate ./my-page --json
npx --yes agentic-report inspect ./my-page --json
npx --yes agentic-report build ./my-page --output ./my-page.html --json

Use the pinned form for repeatable agent work. Use the unpinned form only when intentionally accepting the registry's current latest release.

Choose a starter

  • report for a general report or work summary.
  • research for evidence, findings, and limits.
  • architecture for constraints, alternatives, and decisions.
  • tutorial for ordered teaching material.
  • dashboard for dense status and metrics.
  • landing for a product or project page.

npx --yes agentic-report examples --json lists the installed starters and realistic showcase sources.

Inspect the contract

Use the CLI as the runtime source of truth:

npx --yes agentic-report@0.2.0 describe --json
npx --yes agentic-report@0.2.0 schema --scope source
npx --yes agentic-report@0.2.0 examples --json

Read the complete agent reference, the declarative source contract, or the agentic-report skill when more guidance is needed.

Boundaries

The tool reads local source and writes a static page. It does not deploy, publish, fetch remote source, use credentials, host an editor, or provide live collaboration. Remote assets, raw HTML, executable templates, and author JavaScript are not supported.

Contents