--node

Compute node display name or entity_ref, resolved via control plane /list-compute-nodes and pinned for the session.

Category: global-flags

Syntax

--node <NAME>

Description

## Overview `--node` names a specific compute node for this invocation. The value may be the human-friendly display name shown in `/nodes` output, or the internal `entity_ref` form (for example `cnode::prod-worker-01`). The CLI resolves the name against the control plane's `/list-compute-nodes` endpoint and pins routing to that node. This is the session-level equivalent of the `/use-node` slash command inside the REPL. ## Behavior - Resolution happens at startup. A successful lookup stores both the display name and the node's compute URL for subsequent requests. - If the name does not match any registered node, the startup TUI opens a node picker. Non-TTY invocations fail with a clear error instead of prompting. - While `--node` is active, Auto routing is effectively off for this session. Statements go to the pinned node. - The `query` subcommand accepts its own `--node` flag, which overrides the global flag for that one invocation only. - Subsequent `/use-node` or `/auto` slash commands inside the REPL can change the routing mode at runtime. ## Compatibility - `--node` and `--compute-url` are both valid at the same time. `--compute-url` wins for the raw URL, while `--node` supplies the display name used in prompts and diagnostics. - The flag is honoured by the REPL, the interactive shell, `query`, and `run`. It has no effect on `auth` or `health`, which target the control plane only.

Examples

# Pin a query to a named worker
delta-forge-cli --node prod-worker-01 query SELECT * FROM analytics.daily_revenue
# Enter the shell with a preferred node for the session
delta-forge-cli --node worker-az-east-1
# Use the entity_ref form (internal identifier)
delta-forge-cli --node cnode::prod-worker-01 query 'SELECT current_compute_node()'
# Combine with a profile so URLs come from config and the node name from the flag
delta-forge-cli --profile production --node analytics-hot-01 run reports/daily.sql

Pitfalls

See Also

Open in interactive docs →   DeltaForge home →