Orkestra CLI Reference

The ork CLI manages the full lifecycle of an Orkestra operator — scaffolding, validation, templating, code generation, runtime execution, and live inspection.

This page provides a brief overview of each command.
Select a command to view its full documentation.

Default file resolution

Commands that accept a Katalog or Komposer (ork run, ork validate, ork plan, ork simulate, ork template) look for katalog.yaml first, then komposer.yaml. If neither exists the command errors. To use a file with a different name, pass it explicitly: ork run -f my-katalog.yaml.

Exceptions
`ork e2e` looks for `e2e.yaml`. `ork simulate` looks for `simulate.yaml`. Both fall back to the Katalog/Komposer resolution above when their primary file is not found.

Operator Commands Overview

Command	Description
`ork init`	Scaffold a new operator project (dynamic or typed)
`ork validate`	Validate and merge Katalogs or Komposers
`ork plan`	Show what would change if the local Katalog were applied
`ork simulate`	Simulate operator reconciliation in memory — no cluster needed
`ork e2e`	Run declarative end-to-end tests against a real cluster
`ork template`	Render the merged, post‑validation Katalog
`ork generate registry`	Generate runtime registry for typed CRDs and hooks
`ork run`	Start the runtime
`ork version`	Print version and build information

Registry Commands Overview

Command	Description
`ork push`	Publish a pattern to the OCI registry — runs simulate and E2E gates first
`ork pull`	Download a pattern to the local cache
`ork inspect`	Show metadata and quality signals for a pattern without downloading it
`ork patterns`	List available patterns in the registry

Tooling

Command	Description
`ork control`	Start the Orkestra Control Center web UI
`ork diff`	Show a colorized unified diff between two files
`ork notes`	Browse and search built-in Katalog template functions
`ork migrate`	Rewrite a controller-runtime Reconcile method to the Orkestra constructor signature
`ork create cluster`	Create a local kind cluster for development or testing
`ork upgrade`	Upgrade the Orkestra CLI to the latest or a specific version
`ork uninstall`	Remove the CLI, Control Center binary, cache, and completions