01 · Try it
Start locally with a real answer
Bring up kind, Ollama, and pinned Orka, then require a fresh Task to return a readable result.
kmx quickstartOpen getting started A Kubernetes-native path from editable workspace to evidence-bound deployment.
Choose your path
01 · Try it
Bring up kind, Ollama, and pinned Orka, then require a fresh Task to return a readable result.
kmx quickstartOpen getting started ↗02 · Ship it
Author one workspace member, evaluate every case once, publish the exact OCI graph, and lift its immutable digest.
create → eval → push → liftFollow the workspace lifecycle ↗03 · Operate it
Send one Task or open an interactive session while keeping live runtime operations separate from workspace proof.
kmx run · kmx chatExplore live interaction ↗04 · Extend it
Trace the command tree, runtime seams, safety invariants, and verification gates used by contributors.
make · go test ./...Read the developer guide ↗Agent Builder CLI for Kubernetes.
Documentation · Getting started · Workspace lifecycle · Runtime support · kmx reference · Developer guide · Contributing
Kaimahi's kmx CLI helps developers author and prove agents for Kubernetes. A workspace is editable source; its prepared AgentSuite is the immutable, content-addressed OCI artifact. The selected runtime owns execution and enforcement.
A workspace does not rename or replace AgentSuite. It is the mutable authoring tree that KMX resolves into the portable AgentSuite artifact used for publication and Lift.
Create → Prove → Lift is available in v0.6.0 for one-member native Orka and exact-v0.10.3 Go kagent suites. Bounded CI qualifies root Lift for Orka exact reuse, bounded absent-pair registry promotion and kagent fresh-target creation; it does not prove every promotion, creation or partial-outcome path.
NOTE
The table below is available in v0.6.0. See command migration and releases when upgrading from an older version.
| Stage | v0.6.0 |
|---|---|
| Create | kmx create NAME --workspace DIR --model MODEL --instructions FILE authors one tool-free workspace member offline: Orka by default, exact Go kagent with --runtime kagent, or pinned chat with --runtime agentsessions. No Kubernetes, image build or model call. |
| Prove | Orka uses kmx eval --workspace DIR --to-context CTX --inference provider:NAME --out RECEIPT; kagent uses --bindings FILE instead of --inference. Native AgentSessions instead requires --development-host FILE, a private literal-loopback host JSON, with no cluster selectors. Each runs ordered cases once, stops later cases after the first non-pass, and writes private evidence only when all cases pass. |
| Publish | kmx push --workspace DIR --evaluation RECEIPT REF checks that evidence against the exact OCI manifest and publishes that graph. Plain kmx push REF remains explicitly unevaluated. Neither form deploys. |
| Lift | kmx lift REF@sha256:DIGEST --to-context CTX --evidence RECEIPT plus Orka --inference provider:NAME or kagent --bindings FILE deploys the matching packaged runtime without building, repacking, or publishing. --plan is GET-only; kagent refuses occupied targets; suite status and retirement remain unavailable. |
Create and push discover the nearest ancestor workspace.yaml; --workspace DIR selects an exact root without fallback. Read the workspace lifecycle for identities, evidence privacy, exact evaluated-subject reuse, absent-only source-evidence --promote, partial outcomes, and fresh-evaluation requirements.
Install Docker or Podman (CONTAINER_ENGINE=podman selects Podman), then choose one independent install route for the latest stable release. Go installs require Go 1.26 or newer:
brew install kaimahi-agents/tap/kmx
# or
curl -fsSL https://raw.githubusercontent.com/kaimahi-agents/kaimahi/main/install.sh | sh
# or
go install github.com/kaimahi-agents/kaimahi/cmd/kmx@v0.6.0Check what was installed, then run the fixed, non-interactive local proof:
kmx version
kmx quickstartkmx quickstart creates a local kind environment, starts Ollama and pinned Orka, and succeeds only after a fresh Task returns a readable answer. Use kmx quickstart --interactive for guided native workspace authoring, full eval, publication and reviewed Lift. Follow getting started for prerequisites and explicit context selection.
| Path | What it means |
|---|---|
| Workspace | Default kmx create, root eval, and root push operate on editable source. Digest-based root lift does not consume workspace source; it uses the packaged artifact and separate private evidence with explicit target and inference inputs. Run/chat still target live Agents. |
| Local environment | kmx local up prepares kind, model and runtime without creating an Agent. The experimental Go AgentEnvironment interface is setup-only and is not wired to this command yet. |
| Live Agent | kmx run --agent NAME --prompt TEXT performs one Task on an independent live Orka Agent; kmx chat NAME opens an Orka session. Suite-owned Agents refuse legacy invocation; neither is workspace-local execution. |
| Legacy bundle | Removed outright: user agent.yaml readers/writers, commands and receipts, create --live including previews/wizard, run's bundle mode and --bundles flags. Old receipts are unreadable; no conversion, migration or on-disk/resource deletion. Public AgentSuite implementation bundles are a different format and remain supported. |
A runtime executes and governs the agent. An inference provider is the separate model-access binding; selecting one does not select the other.
eval --bindings, evaluated publication and create-only root digest Lift. Standalone run/chat, Python, RemoteMCP, suite status and retirement remain unavailable.eval --development-host FILE: one fresh Session/config/Exec per case, full-pass private proof and exact-S evaluated push. This unauthenticated literal-loopback development path loads no cluster settings; it supports no tools/judge, Lift/chat/status or remote lifecycle. Receipt diff refuses its proof. Read-only reference extraction/export and availability probing remain separate; legacy bundle evaluation/replay is removed.The runtime support matrix records exact pins and evidence rather than claiming feature parity.
IMPORTANT
Kaimahi is experimental and under active development. It is not recommended for production use. Use a dedicated test environment, review every proposed mutation, and remember that hosted model calls can incur charges.
kmx status and kmx orka status report Orka runtime state, not AgentSuite deployment status./lift and console Lift only print Lift moved: kmx lift <ref>@<digest> --to-context … --evidence …; no release GUI or live-copy fallback remains.kmx local down deletes the entire named local cluster and its data.NOTE
kmx is the Agent Builder and lifecycle layer, not a runtime or generic governance control plane. The selected runtime owns execution and enforcement.
| Need | Guide |
|---|---|
| Install and get one answer | Getting started |
| Author, evaluate and publish a workspace | Workspace lifecycle |
| Understand exact runtime support | Runtime support |
| Find every implemented command | kmx reference |
| Read the portable artifact contract | AgentSuite specification |
| Select models and inference | Models, Copilot, Foundry |
| Install or upgrade | Releases |
| Browse all guides | Documentation index |
From a checkout, make builds bin/kmx without provisioning. Start with the developer guide, codebase overview, and interface baseline. The repository map classifies tracked source and scaffolding; contributing defines verification and pull-request expectations. See naming for publication boundaries. Run make docs-preview for the browser-style documentation preview generated directly from these Markdown files.