For AI agents: the complete documentation index is available at https://scriptedalchemy.github.io/agent-bundle/llms.txt, the full documentation bundle is available at https://scriptedalchemy.github.io/agent-bundle/llms-full.txt, and this page is available as Markdown at https://scriptedalchemy.github.io/agent-bundle/reference/index.md.
agent-bundle
  • English

      • Reference

      The Guide explains how to build and ship a bundle. This section is the lookup half: exact flags, exact field names, exact defaults, and the boundaries the framework refuses to cross.

      Nothing here repeats a walkthrough. Where a concept is already explained in the Guide — the configuration model, the seven hook events, the proof levels — these pages link to it and record only the contract.

      PageAnswers
      CLIEvery command, argument, option, default, and exit code.
      ConfigurationEvery agent-bundle.config.ts field, its type, and its validation rule.
      Targets and artifactsWhat each target emits, and the artifact manifest contract.
      Host capability matrixThe pinned per-host capability tables: versions, manifests, install surfaces, path tokens, MCP transports, plugin components. Generated at build time.
      Event and hook matrixCanonical events to native events per host, tool selectors to native matchers, deferred native events. Generated at build time.
      Notice delivery matrixWhich notice channels each host supports and why the rest are unavailable. Generated at build time.
      Diagnostics referenceEvery AB code family, trigger, severity, and recovery hint. Generated at build time from the repository contract.
      Runtime environmentNode floors, path tokens, environment variables, .env layering, and durable state locations.
      SecurityThe credential, network, and trust boundaries.
      LimitationsWhat the framework does not currently do or prove.
      Type APIThe generated symbol reference for every public export.

      Reading the diagnostics

      Every command reports structured diagnostics rather than prose errors. One diagnostic is a stable AB code, a severity, a message, and usually a sourcePath and a recovery hint. For the diagnostic-gated commands — build, prepack, validate, doctor, install, and dev — only an error severity makes the command exit nonzero; warnings and infos never gate a build, a validation, or a dev rebuild. eval and inspect have an extra, non-diagnostic reason to exit 1: a failing or inconclusive trial, or an invalid model — see the CLI exit codes.

      The full code catalog is the Diagnostics reference, rendered at build time from the repository's docs/diagnostics.md.

      FamilyArea
      AB30xxSkill documents: Markdown parsing and rendered-skill compilation.
      AB40xx–AB47xxPlugin metadata, normalized model invariants, hooks, MCP, scripts, assets, package build, and the bundler escape hatch.
      AB48xx–AB49xxRoute graph, state, layout, and provider conventions: route module discovery, config extraction, shared layouts (AB4830–AB4832), and the compiled command surface.
      AB5000General CLI and adapter failures.
      AB60xxBuilt-artifact validation, including host schema documents and referenced files.
      AB700x–AB7013Host installation and the npm prepack gate.
      AB7xxxProject preparation and development rebuilds, plus the read-only Doctor at AB7300–AB7320.
      AB8xxxDevelopment server configuration and Workbench routes.
      AB9xxxEval selection, harnesses, and persisted runs.