CLI reference
A single static binary, zero runtime dependencies, human-friendly output by default and machine-friendly output with --json. Every REST endpoint has a matching CLI verb.
Installation
# Homebrew (recommended)brew install dxdata/tap/dxdata # Or one-linercurl -fsSL https://get.dxdata.io | shCommon commands
dxdata loginStart an OIDC device-code login flow. Writes tokens to the OS keychain.
dxdata logoutRevoke the current session and delete cached tokens.
dxdata queryRun a query against the workspace. Supports json, csv, and table output.
dxdata branch listShow every branch in the catalog with its HEAD snapshot and last-author.
dxdata branch createCreate a new branch from main, a tag, or another branch.
dxdata branch mergeMerge a branch into the target. Fails fast on conflicts; prints a diff.
dxdata catalog listEnumerate catalogs, schemas, tables, and columns with their types.
dxdata catalog describeShow schema, partitioning, snapshot history, and active policies.
dxdata pipeline runTrigger a pipeline run. Streams logs and exits with the run status code.
dxdata pipeline statusList recent runs for a pipeline with durations and outcome.
dxdata applyApply a declarative config — sources, pipelines, policies, users.
dxdata whoamiPrint the current identity, active workspace, and session expiry.
Global & common flags
| Flag | Description | Applies |
|---|---|---|
| --workspace <slug> | Override the active workspace for a single command. | global |
| --branch <ref> | Target a specific branch or tag instead of main. | query, catalog |
| --format <fmt> | Output format: table (default), json, csv, ndjson. | query, catalog |
| --output <path> | Write results to a file instead of stdout. | query |
| --profile <name> | Use a named profile from ~/.dxdata/config. | global |
| --quiet | Suppress progress, banners, and non-essential output. | global |
| --json | Alias for --format json. Structured output for scripts. | global |
| --timeout <dur> | Client-side timeout, e.g. 30s or 5m. Server may still enforce its own. | query, pipeline |
SDKs
First-party SDKs wrap the REST API for Python, TypeScript, and Go. Each ships typed clients for queries, branches, and pipelines, with async iteration over row streams. Install with pip install dxdata, npm i @dxdata/client, or go get github.com/dxdata-dev/dxdata-go.
Observability
Pipe any CLI command through --trace to emit OpenTelemetry spans for the client-side call, and use dxdata query profile <query-id> to pull the full engine-side execution plan, per-stage stats, and split-level timings.