Kaimahi documentation
KMX is the Agent Builder CLI. Runtimes execute and govern agents. Start with the first-answer or suite-workspace path below. Native Orka and exact-v0.10.3 Go kagent workspaces can be evaluated, published, then lifted by packaged digest; legacy user bundles/readers/receipts and live create are removed outright. Use the runtime contract when extending or comparing implementations.
NOTE
The browser documentation renders main and may include unreleased behavior. Tagged Markdown is the stable historical record; see the documentation-site version boundary.
Current operator paths
| I want to… | Read |
|---|---|
| Set up the current development CLI and understand prerequisites | Getting started |
Inspect compiled runtime support and qualification evidence with kmx targets; understand runtime and inference boundaries | Runtime contract and support matrix |
| Install Orka, inspect before applying, or see the version actually running | Orka |
| Define or validate a portable OCI AgentSuite with bundled or remote ToolProviders and standalone provider sandbox images | AgentSuite Artifact Specification |
| Author one native suite member offline, evaluate the Orka or exact kagent profile, publish the exact OCI graph, and lift that packaged digest | Suite workspace |
| Discover models and configure native inference | Models, Copilot inference, Foundry inference |
| Chat with an existing Orka Agent | Interactive chat |
| Use an existing AKS cluster or provision a disposable one | AKS |
| Find a command, its safety contract, and supported output modes | kmx reference |
| Install a tagged release or understand version and upgrade limits | Releases |
| Diagnose installation, inference, or runtime problems | FAQ |
Default create authors offline source. Exact-v0.10.3 Go/linux-amd64 kagent supports packaged eval/evaluated publication/create-only digest Lift; Orka remains default. No user bundle conversion/migration or saved-file/resource deletion occurs. Old receipts are unreadable. Suite status/retirement, kagent standalone run/chat, Python and RemoteMCP remain unavailable. Public AgentSuite/ToolProvider implementation-bundle formats, build/pull and extracted-directory transfer remain. See format boundaries and current CLI contracts.
Maintainer references
- Development: source boundaries, verification and operational traps.
- Documentation site: one-command local preview, source-of-truth, versioning and publication boundaries.
- Codebase overview: architecture, package responsibilities, core data flows and safety invariants.
- Interface baseline: exact current command tree, workspace/live split, runtime limits and alpha Go surfaces.
- Repository map: native tooling, packaging, compatibility data and test scaffolding.
- CLI presentation: current terminal and automation contracts.
- Command alignment: implemented entry points, compatibility policy and remaining vocabulary decisions.
- Command conventions: naming, flag, output and compatibility rules for kmx commands.
- Charm boundary: the implemented creation wizard and its limits.
- Interactive agent TUI: two-environment overview, keyboard navigation, slash-command completion and demo mode.
- Suite-first lifecycle direction: workspace, release, deployment and evaluation objects; partly implemented, not an operator recipe.
- KMX lifecycle interface decision: rationale for the experimental target, platform, runtime, deployment and receipt boundaries.
- KMX application API: how another Go layer uses AgentEnvironment, AgentSuites and AgentDeployments while management ports remain internal.
- KMX public interface summary: the current layering, setup-only environment contract and CLI-to-Go mapping; environment recovery and teardown remain deferred.
- Naming: the name and publication constraints.
Assessments that inform current work
- Full chat latency profile: local, AKS/Foundry and Copilot measurements and optimization priorities.
- Local Foundry inference: interactive host inference with Azure login, and the separate native Orka integration proposal.
Maintained documentation provides current guidance. For superseded material, consult Git history.