--control-url

Override the control-plane base URL for this invocation. Highest precedence (wins over env and profile).

Category: global-flags

Syntax

--control-url <URL>  (env: DF_CONTROL_URL)

Description

## Overview `--control-url` sets the base URL that the CLI uses for every control-plane API call: authentication, `/list-compute-nodes`, `/nodes/recommend`, health checks, and session endpoints. It is the highest-precedence source for this value, overriding `DF_CONTROL_URL` and any `control_url` defined by the active profile. The built-in default is `http://localhost:3000`, which matches a single-machine dev install. ## Behavior - Accepts any URL the underlying HTTP client accepts. No trailing slash is required; the CLI composes paths with a leading slash. - Applies to every request that targets the control plane for this process lifetime. Subsequent invocations must repeat the flag or rely on env/profile. - Does not imply anything about compute routing. Compute URL resolution is independent and is controlled by `--compute-url`, `DF_COMPUTE_URL`, or the profile's `compute_url`. - When `--control-url` is set and the URL is unreachable, subcommands fail with a client-initialisation error rather than falling back to the default. ## Compatibility Resolution order for the control URL: `--control-url`, `DF_CONTROL_URL`, profile `control_url`, built-in default `http://localhost:3000`. Each tier wins over the tiers below it.

Examples

# Point at a remote control plane for a health check
delta-forge-cli --control-url https://control.company.com health
# Set once for the shell session via env var
DF_CONTROL_URL=https://control.company.com delta-forge-cli
# Combine with explicit credentials to avoid the default admin account
delta-forge-cli --control-url https://control.example.com --username ops@example.com --password $DF_PASS query 'SELECT 1'
# Test a canary control plane while keeping the production profile for everything else
delta-forge-cli --profile production --control-url https://control-canary.example.com health

Pitfalls

See Also

Open in interactive docs →   DeltaForge home →