CLI Reference¶

Run arxyne --help for the authoritative, up-to-date command list.

Setup¶

arxyne --version                    # Print version
arxyne --doctor                     # Pre-flight: Python, Docker, GPU, solver images
arxyne --pull openfoam              # Pull solver image from GHCR
arxyne --pull all                   # Pull all solver images
arxyne --onboarding                 # Guided setup (interactive)
arxyne --onboarding --from FILE     # Import product spec from YAML
arxyne --update                     # Upgrade arxyne to latest version

Products¶

arxyne --list                       # List available products
arxyne --product NAME --info        # Product summary: identity, targets, recent runs
arxyne --product NAME --results     # Latest KPIs, gate status, run history
arxyne --baseline-history --product NAME  # Baseline-promotion audit trail

Simulation¶

arxyne --product NAME --aero                    # Aero with default solver
arxyne --product NAME --aero --solver openfoam  # Explicit solver
arxyne --product NAME --aero --solver xlb       # GPU LBM
arxyne --product NAME --aero --solver domino    # AI surrogate (DoMINO NIM)
arxyne --product NAME --dynamics                # Vehicle dynamics (all 4 ISO manoeuvres)
arxyne --product NAME --run-workflow            # Full multi-domain workflow

Simulation Flags¶

Flag	Description
`--product NAME`	Product to operate on (required for most commands)
`--solver NAME`	Aero solver: `auto`, `openfoam`, `xlb`, `domino`
`--body-res N`	XLB body resolution in lattice cells (default: 128)
`--steps N`	Override iteration/timestep count

Agent¶

arxyne --ask "What's the Cd?" --product ahmed   # Query the digital twin (needs LLM)

--ask requires --product and an LLM backend (Ollama locally, or an API key for Anthropic/DeepSeek/etc).

Solver Management¶

arxyne --solvers                    # List solver registry and status
arxyne --start-solver gateway       # Start the MCP Gateway
arxyne --stop-solver gateway        # Stop the MCP Gateway

The gateway auto-starts when a simulation is dispatched, so explicit start is optional.

History¶

arxyne --clean-history --product NAME       # Deduplicate and trim (default: 90 days)
arxyne --clean-history 30 --product NAME    # Keep last 30 days

Experimental (v0.2.0, gated)¶

These features are hidden from --help and return exit code 2 with a notice when ARXYNE_EXPERIMENTAL is unset:

# Product scaffolding
ARXYNE_EXPERIMENTAL=1 arxyne --new-product NAME --template drivaer-notchback
ARXYNE_EXPERIMENTAL=1 arxyne --delete-product NAME

# Release management
ARXYNE_EXPERIMENTAL=1 arxyne --freeze v0.2.0 --product ahmed
ARXYNE_EXPERIMENTAL=1 arxyne --list-releases --product ahmed

# Visualisation
ARXYNE_EXPERIMENTAL=1 arxyne --omni --product ahmed
ARXYNE_EXPERIMENTAL=1 arxyne --viz --product ahmed
ARXYNE_EXPERIMENTAL=1 arxyne --replay step_steer --product ahmed

New Product Flags (experimental)¶

Flag	Description
`--new-product NAME`	Scaffold from template
`--delete-product NAME`	Remove product and all data
`--display-name NAME`	Human-facing name
`--template PRODUCT`	Clone properties from existing product
`--force`	Overwrite existing product
`--no-initial-release`	Skip v0.0 freeze
`--no-validate`	Bypass seed-value validation