Technical reference
For development onboarding, see init, doctor and shell completion.
For your first project, follow Quickstart, then The full journey. Read the Capability Compiler overview for the full flow. This reference is for using individual interfaces or understanding their contracts. See Install Apizr for package availability and prerequisites. The release notes explain version differences.
Commands and parameters
Modern compiler workflows
Each linked command guide describes its options, outputs and refusals. Modern
inspect, generate and execute are part of the compiler workflows, not the
historical pipeline.
| What you need | Where to look |
|---|---|
| Authorize source access and delivery operations | Operator permissions |
| Acquire a Git snapshot | HTTPS / SSH |
| Build and publish service images | OCI plugin |
| Sign and transport delivery proofs | Attest / OCI proofs |
| Invoke an already installed extension | Extension invocation |
| Install and list local extensions offline | Local extensions |
| Configure readiness and exposure with a project file | Project configuration |
| Call repository readiness, planning and generation from Python | Compiler API |
| Export or safely regenerate Postman, Bruno and Insomnia collections | Client collections |
| Plan and build REST/MCP from a repository | Repository exposure |
| Inventory a Python repository | Scanner, graph and repository readiness |
| Generate MCP from a Python file or notebook | MCP guide |
| Execute under a policy | Local and OCI execution |
| Inspect one Python file or notebook without execution | Inspection guide and readiness policy |
| Generate REST from a Python file or notebook | REST guide and generator contract |
| Inspect source using the independent typed Python API | Capability IR, including serialization, digests and diagnostics |
| Understand guarantees and limits | Artifact principles, security baseline |
The MCP generator contract describes the Tools backend and the interface semantics shared with REST.
Legacy pipeline — compatibility
These entries describe the historical pipeline and its HTTP generation service, separately from the modern compiler commands above.
| What you need | Where to look |
|---|---|
| Run one pipeline stage from the command line | Python analysis, FastAPI generation, Docker generation |
| Understand or call a pipeline component | Notebook conversion, Python analysis, FastAPI generation, Docker generation |
| Generate files through Apizr's HTTP service | Service setup and project upload, with the stage endpoints in the same navigation group |
| Understand compatibility guarantees | Legacy behavior contract |
The HTTP generation service is Apizr's own interface for producing files. It is
separate from the business API produced by a conversion; the generated
application exposes its own /docs schema when started.
The historical pipeline and Capability IR remain independent. The new REST generator consumes IR and readiness; legacy FastApizr and Dockerizr retain their existing analysis and output.
Policies and formats
Use the existing JSON contracts; these links explain their fields and validation. Project TOML configuration in 0.4 references policy files rather than replacing the policy languages.
| Format or parameter group | Specification |
|---|---|
| Scan exclusions and source roots | Scanner parameters |
| Readiness policy and reports | Repository readiness |
| Exposure policy and plan | Exposure Plan |
| Bundle artifacts and manifests | Repository Bundle |
| Direct/governed execution choices | Exposure guide |
| Worker execution policy | Execution Policy, OCI |
| Project and explicit user configuration | Project configuration, plugin declarations and locks |
| Extension invocation messages | Extension protocol |
Python APIs
The compiler API can be called directly from Python, independently of the CLI. Existing lower-level contracts are documented alongside the Capability IR, readiness and generator architecture.