Skip to main content

orun CLI

The root orun command is the entry point for planning, inspection, and execution.

Command map

CommandPurpose
orun planCompile intent and compositions into a deterministic execution plan
orun runExecute a compiled plan (executes by default; use --dry-run to preview)
orun statusShow execution status for the latest or a specific execution
orun logsStream or filter per-step logs from an execution
orun getList resources: plans, runs, jobs, components, environments
orun describeShow detailed information for a run, plan, job, or component
orun gcClean up old executions and orphan plan files
orun validateValidate intent and discovered components against schemas
orun debugInspect intent processing and planning internals
orun compositionsList or inspect available compositions
orun componentList components or inspect a merged component view
orun completionGenerate shell completion scripts

Global flags

FlagMeaning
--intent, -iIntent file path (auto-discovered from CWD if not set)
--config-dir, -cLegacy fallback path or glob for folder-shaped compositions
--allDisable CWD-based component scoping; process all components
--versionPrint the CLI version
--helpShow command help

--intent auto-discovers intent.yaml by walking up the directory tree to the git root. Pass it explicitly to override.

--config-dir can also be set through ORUN_CONFIG_DIR, but packaged composition sources declared in the intent are the recommended path.

Typical flow

# Plan from anywhere in the repo
orun plan

# Inspect what was planned
orun get jobs
orun status

# Execute
orun run

# Review logs if needed
orun logs

When you run commands from inside a component directory, orun automatically scopes to that component and its dependencies. Use --all to override scoping. See context-aware discovery for details.

Read the command-specific pages next if you need examples and flag details.