Reference
CLI Commands
Complete reference for all dxcore CLI commands and flags.
Overview
The CLI binary is dxcore. It provides four top-level commands: agent, dispatch, ci, and config.
dxcore agent
Connect to the coordinator, receive and execute assigned tasks.
dxcore agent [flags]
| Flag | Short | Required | Default | Description |
|---|---|---|---|---|
--coordinator |
-c |
Yes | — | Coordinator URL |
--agent-id |
-a |
Yes | — | Unique agent identifier |
--session-id |
-s |
Yes | — | Session ID to join |
--token |
-t |
Yes | — | Bearer token |
--work-dir |
-w |
No | . |
Working directory |
--build-system |
-b |
No | turbo |
Adapter: turbo, nx, generic, docker |
--tags |
— | No | — | Comma-separated capability tags (e.g., zone=us,gpu=true) |
dxcore dispatch
Read a task graph from stdin, submit to the coordinator, and stream results.
turbo run build --dry=json | dxcore dispatch [flags]
| Flag | Short | Required | Default | Description |
|---|---|---|---|---|
--coordinator |
-c |
Yes | — | Coordinator URL |
--session-id |
-s |
Yes | — | Session ID |
--token |
-t |
Yes | — | Bearer token |
--timeout |
-T |
No | 900 |
Timeout in seconds |
--build-system |
-b |
No | turbo |
Adapter: turbo, nx, generic, docker |
--work-dir |
-w |
No | . |
Working directory |
--failure-strategy |
-f |
No | — | fail-fast or continue-all |
dxcore ci
CI lifecycle helper subcommands.
ci create-session
Create a new session on the coordinator.
dxcore ci create-session -c $URL -t $TOKEN
Outputs the session ID to stdout.
ci wait
Poll the coordinator health endpoint until it is reachable.
dxcore ci wait -c $URL --timeout 300
ci finish
Mark a session as complete and report the dispatcher result.
dxcore ci finish -c $URL -s $SESSION -t $TOKEN -d success
| Flag | Short | Required | Default | Description |
|---|---|---|---|---|
--coordinator |
-c |
Yes | — | Coordinator URL |
--session-id |
-s |
Yes | — | Session ID |
--token |
-t |
Yes | — | Bearer token |
--dispatcher-result |
-d |
No | success |
Dispatcher result to report |
ci shutdown
Request graceful coordinator shutdown.
dxcore ci shutdown -c $URL -t $TOKEN
dxcore config
Display shard configuration.
dxcore config [-w <path>]
Scans for dxcore.json files in the working directory and displays resolved shard configuration.
Coordinator API
| Endpoint | Method | Description |
|---|---|---|
/api/sessions |
POST | Create a session, returns {"session_id": "..."} |
/api/sessions/:id/finish |
POST | Mark session complete |
/api/shutdown |
POST | Graceful shutdown |
/api/health |
GET | Health check |
WebSocket channels: dispatcher:${session_id} and agent:${session_id}.