Technical reference
For shared definitions, see Concepts and limits. For a task progression, choose User guide, Developer guide or Operations guide.
For development onboarding, see init, doctor and shell completion.
For your first project, follow Quickstart, then The full journey. Read the Architecture guide for the system's components, data flows and execution boundaries. Its contract chapters retain the detailed architecture specifications. 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.
Removed historical pipeline
The legacy CLI, HTTP generation service and step-plugin APIs were removed in
0.4.6. The migration table
records every former entrypoint and its modern replacement.
Notebook conversion remains supported through
apizr.notebooks; it does not execute cells.
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.