Reference Overview
This reference documents the public contract of Agent Plugin Compiler. It states what the package accepts and produces. The Guide explains why, and shows the workflow around it.
Contract surfaces
| Surface | Documentation | Answers |
|---|---|---|
| Authored source | Manifest v1 and v2 | Where source files go, and every field and rule |
| Executable commands | CLI | Commands, options, and exit codes |
| Generated hosts | Providers | Which manifest each provider writes |
| Programmatic use | Programmatic Usage | The Node.js API and custom adapters |
Sources of truth
The package behavior is defined by executable and versioned contracts in the repository:
- CLI parsing, help, process tests, and exit codes;
src/schemas/v1/plugin-manifest.schema.json;src/schemas/v2/plugin-manifest.schema.json;- compiler and provider adapter implementations;
- exported TypeScript declarations;
- conformance tests for externally owned provider formats.
If prose and the installed package differ, use the documentation that matches your installed version and verify behavior with focused --help output. The architecture guide documents the internal design.
Stability note
The package is stable and published under npm's latest tag. Pin it exactly, review release notes before upgrading, and recompile output with the upgraded version before accepting the change.
Start with the CLI reference, or follow the Quick Start.