Skip to main content

arx CLI

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

Command map

CommandPurpose
arx planCompile intent and compositions into a deterministic execution plan
arx runDry-run or execute a compiled plan
arx validateValidate intent and discovered components against schemas
arx debugInspect intent processing and planning internals
arx compositionsList or inspect available compositions
arx componentList components or inspect a merged component view
arx completionGenerate shell completion scripts

Global flags

FlagMeaning
--config-dir, -cPath or glob used to load composition assets
--versionPrint the CLI version
--helpShow command help

--config-dir can also be set through ARX_CONFIG_DIR.

Typical flow

arx validate --intent intent.yaml --config-dir assets/config/compositions
arx plan --intent intent.yaml --config-dir assets/config/compositions --output plan.json
arx run --plan plan.json

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