Skip to content

Axis CLI Reference

Commands

CommandDescription
axis / axis runRun in TUI mode
axis run --headless --world=<name>Run in headless mode
axis worldsList discovered worlds
axis auth <world>Generate auth URL (non-blocking if no TTY)
axis auth <world> --redirect-urlComplete auth with redirect URL
axis auth <world> --session-dataComplete auth with raw base64 session data
axis auth <world> --statusCheck session status for one world
axis auth <world> --method=passwordDirect password auth (no browser needed)
axis auth --allAuth all discovered worlds
axis auth --all --statusCheck status for all worlds
axis doctorValidate configuration
axis init [world]Manually seed runtime directories and config (optional — all directories are auto-created when needed)
axis --versionPrint version
axis --helpPrint usage

Run Flags

FlagDescription
--headlessRun without TUI
--world=<name>Target world (required for headless)
--auth=session|privatekeyAuth strategy
--api-port=<port>Enable HTTP API
--api-host=<host>API bind host
--stdinEnable stdin command stream
--verbosity=quiet|actions|decisions|allOutput filter
--jsonJSON output for command responses

Auth Flags

FlagDescription
--allTarget all discovered worlds
--statusCheck session status instead of generating auth URL
--redirect-url=<url>Complete auth with the redirect URL from browser
--session-data=<base64>Complete auth with raw base64 session data
--method=passwordDirect password auth (no browser needed)
--username=<user>Username for password auth
--password=<pass>Password for password auth
--callback-url=<url>Public callback endpoint
--timeout=<ms>Approval wait timeout