CLI command reference.

Global flags

FlagPurpose
-c, --config PATHUse an explicit configuration file
-o, --output human|jsonSelect rendering; use JSON in scripts
--endpoint URLConnect to any worker
--credential SECRETAuthenticate; prefer environment or config
--log-level LEVELSet the tracing filter

Node commands

  • orbita serve runs a clustered combined node.
  • orbita dev runs one local node as its own voter and worker.

Important serve flags include --node-id, --listen, --advertise, --peer-listen, --peer-advertise, --data-dir, --voter-target, --failure-domain, and --join-timeout.

Data commands

orbita get KEYSPACE KEY
orbita set KEYSPACE KEY VALUE [--ttl DURATION] [--if-not-present | --if-version TOKEN]
orbita delete KEYSPACE KEY [--if-version TOKEN]
orbita list KEYSPACE [PREFIX] [--cursor TOKEN] [--limit N] [--values]

Administration

orbita keyspace create|list|update|delete
orbita credential create|revoke
orbita cluster describe|ping|ready|finalize-upgrade
orbita partition split|merge|transfer
orbita config show|env
orbita repl

Exit codes

CodeMeaning
0Success
1Error or ambiguous failure
2Key not found
3Condition not met

Run orbita <command> --help for exact options. The source of truth is crates/orbita-cli/src/cli.rs.