CLI Reference
Every dxflow command, flag, and option, and where each one runs
One binary drives everything the engine can do. The same commands work against the engine on your machine and against a remote one — pointing the CLI elsewhere is a configuration change, not a different command.
Command groups
| Command | Description | Help |
|---|---|---|
| boot | Engine lifecycle control | dxflow boot --help |
| key | Authentication key management | dxflow key --help |
| config | Config control | dxflow config --help |
| license | License management | dxflow license --help |
| engine | Engine information, health, and updates | dxflow engine --help |
| shell | Shell session management | dxflow shell --help |
| workflow | Workflow lifecycle, logs, and statistics | dxflow workflow --help |
| artifact | File storage on the engine volume | dxflow artifact --help |
| agent | LLM agent sessions | dxflow agent --help |
| platform | Connect the engine to a dxflow platform account | dxflow platform --help |
Global options
Global flags go before the command:
Terminal
dxflow [GLOBAL_FLAGS] <command> [FLAGS]
| Flag | Shorthand | Description | Type | Default |
|---|---|---|---|---|
--config-profile | -C | Specify the config profile | string | default |
--log-level | -L | Specify the log level | string | info |
--no-color | -N | Disable color output | bool | false |
Where a command runs
Every command runs from your machine, but they differ in what they can reach:
- Remote — when
connection-addressis set on the active profile, the command targets that engine instead of the local one. See Remoting. - Instant — with no engine running and no remote configured, the command spawns a temporary engine, does its work, and shuts it down. An instant engine lives exactly as long as the command that spawned it, so anything whose work outlives the call — booting, shells, starting a workflow — needs a persistent engine from
boot up. - Local only — neither applies: the command reads or writes state on this machine.
Resolution order is remote → running local engine → instant engine. Remote commands always use the server's engine, never an instant one.
Root shortcuts
Six commands answer at the root as well, with the same flags:
Terminal
dxflow token # dxflow engine token
dxflow ping # dxflow engine ping
dxflow healthcheck # dxflow engine healthcheck
dxflow stats # dxflow engine stats
dxflow login # dxflow platform login
dxflow logout # dxflow platform logout
Aliases
The binary answers to dxf, each group has a short form, and most subcommands take a familiar Unix name:
| Group | Alias | Subcommand aliases |
|---|---|---|
workflow | flow | ls · make · log · rm · hub find |
artifact | art | ls · touch · push · pull · mv · rm |
shell | sh | ls · new · join · rm |
agent | ai | ls · new · ask · rm |
key | — | ls · add · remove · gen |
license | — | active · deactive |
platform | — | connect · disconnect |
engine | — | healthy · stat |
Terminal
dxf flow ls
dxf art push ./data.csv
dxf ai ask <identity> "start"
Common operations
Terminal
# Configuration
dxflow config set connection-address "https://server.com"
dxflow config get connection-address
# Engine lifecycle
sudo dxflow boot up --console --daemon
dxflow boot down
# Target a remote engine with a named profile
dxflow -C prod workflow list
dxflow -C prod engine stats
Remote setup: see Remoting for profiles, key authentication, and multi-environment management.