Skip to content
Environment Variables

Environment Variables

sind ui runs its commands without your values of the SIND_* variables that stand in for a flag or an argument, so that a run does what its command says. The variables on this page are for the CLI.

A SIND_* variable stands in for a flag, or for an argument, that the command line does not give. Set it once, in a shell profile or for a CI job, and every command that follows uses it:

export SIND_REALM=ci-42
sind create cluster
sind get clusters        # the clusters of realm ci-42

Precedence

sind takes a value from the first of these that gives it, the same way for every variable:

Source Example
The command line sind --realm ci-42 get clusters
The SIND_* variable export SIND_REALM=ci-42
The config file (sind create cluster only) realm: ci-42 in the YAML config
The default sind

A variable set to the empty string counts as not set, except SIND_PROGRESS_LOG, whose empty value writes no event log. A flag given with an empty value counts as given: --progress-log "" writes no event log, whatever SIND_PROGRESS_LOG says.

The help of each flag names the variable that stands in for it, before the default:

$ sind --help
...
      --realm string          realm namespace for resource isolation (default: SIND_REALM, else the realm of a config file, else sind)

SIND_* variables

Variable Stands in for Default See
SIND_REALM --realm the realm of the config file, else sind Realms
SIND_CLUSTER the cluster argument, NAME or CLUSTER, and the cluster of a node argument that names none default; for sind create cluster the name of the config file, else default The cluster
SIND_OUTPUT -o, --output of sind get and sind doctor human Output
SIND_VERBOSE -v, as a number: 2 is -vv 0: errors only Verbose logging
SIND_WAIT --wait of sind create cluster and sind create worker 5m Wait and pull
SIND_PULL --pull of sind create cluster, and of sind create worker with --image false Wait and pull
SIND_PROGRESS --progress auto Progress Display
SIND_PROGRESS_LOG --progress-log the activity log Progress Display
SIND_LOG_TIMESTAMPS no flag: false leaves the time stamp off log lines time stamps MCP
SIND_MCP_TOKEN no flag: the bearer token of sind mcp stream, which a command line would show to the other users of the host a new random token at every start MCP

The cluster

SIND_CLUSTER names the cluster of every command that takes a cluster or nodes and names none, so a shell that works on one cluster does not repeat its name:

export SIND_CLUSTER=dev
sind create cluster           # creates dev
sind ssh worker-0             # worker-0.dev
sind exec -- sinfo            # runs sinfo in dev
sind power off worker-1.prod  # worker-1 of prod: the node names its cluster
sind get nodes                # the nodes of every cluster, as without SIND_CLUSTER

As SIND_REALM wins over the realm of a config file, SIND_CLUSTER wins over its name: sind create cluster --config lab.yaml creates dev, not the cluster lab.yaml names. Give the name as NAME to create that one: sind create cluster lab --config lab.yaml.

Output

SIND_OUTPUT=json makes every sind get and sind doctor print JSON, for a script or an agent that reads it. It changes the commands that print one value too, which then print it inside a JSON object: sind get ssh-config, the keys of get ssh-private-key, get ssh-public-key, get ssh-known-hosts and get auth-key, and get coredns-config. Give them -o human where a script takes the value as it is:

export SIND_OUTPUT=json
sind get clusters                                 # JSON
ssh -F "$(sind get ssh-config -o human)" controller.default.sind.sind

The tools of the MCP server always run with -o json, whatever SIND_OUTPUT says.

Wait and pull

SIND_WAIT and SIND_PULL set how long sind create cluster and sind create worker wait for the nodes, and whether they pull the images first, for example on a slow CI runner that must run the newest image of a tag:

export SIND_WAIT=15m SIND_PULL=true
sind create cluster --config ci.yaml   # pulls its images, waits up to 15 minutes
sind create worker                     # runs the image of the newest worker: no pull
sind create worker --image "$IMAGE"    # pulls $IMAGE

SIND_WAIT takes what --wait takes: a duration with a unit, such as 90s or 15m, or 0 for no limit (see What happens during creation). SIND_PULL takes what --pull=VALUE takes, such as true or false. Without --image, sind create worker runs the image of the cluster’s newest worker, which it does not pull, so it does not read SIND_PULL (see Image and Slurm version).

Values sind cannot use

A variable is not part of the command line, so a value that sind cannot use is no usage error, which exits 2 (see Exit Status):

  • A variable that changes where or how a command acts fails the command with exit status 1, and the error names the variable:

    $ SIND_REALM=ci_42 sind get clusters
    12:00:00.000 ERRO SIND_REALM: invalid realm name "ci_42": '_' is not a letter, a digit or a hyphen
    $ echo $?
    1
    $ SIND_OUTPUT=yaml sind get clusters
    12:00:00.000 ERRO invalid SIND_OUTPUT value "yaml": want human or json
    

    sind checks the variable only when it is in effect: sind --realm ci get clusters does not read SIND_REALM, sind version reads no realm, sind ssh worker-0.dev reads no SIND_CLUSTER, and sind create worker without --image reads no SIND_PULL.

  • A variable that changes only what sind shows on standard error fails no command. With a value of SIND_PROGRESS or SIND_PROGRESS_LOG that sind cannot use, it shows no progress, or writes no event log, and says why in one line. A SIND_VERBOSE that is no number is ignored:

    $ SIND_VERBOSE=-vv sind get realms
    sind: SIND_VERBOSE is "-vv"; it takes a number, such as 2 for -vv; it is ignored
    NAME  CLUSTERS
    sind  2
    

sind ui and the MCP server

sind ui runs the commands of its dialogs without the values its own environment gives the variables that stand in for a flag or an argument, so that a run does what the command it shows says. It sets two of them itself: SIND_PROGRESS to none, and SIND_PROGRESS_LOG to the activity log, which it reads to show the run. The commands it shows leave out what you would not type: the realm sind, the cluster default, a --wait of 5m and a --pull that is off. In a shell with SIND_REALM, SIND_CLUSTER, SIND_WAIT or SIND_PULL, a copy of one takes their values instead. Some always name the realm or the cluster: Copy script of New cluster names the realm and the cluster, Delete realm the realm, Delete cluster and Delete clusters each cluster, and Delete workers the cluster of the workers, default too.

The MCP server runs its tool calls in its own environment, with these changes: --realm of sind mcp start or sind mcp stream, when given, sets SIND_REALM; SIND_PROGRESS is none, SIND_PROGRESS_LOG is not set, and SIND_LOG_TIMESTAMPS is false. A call that leaves out a flag or the cluster takes the variable of that environment, as a command does: sind_create_cluster without wait waits as long as SIND_WAIT says. An editor starts the server with the environment of its entry, not that of your shell: sind mcp <editor> enable writes the realm into the entry.

Other variables

sind also reads these variables, which other programs define:

Variable What it changes
DOCKER_HOST, DOCKER_CONTEXT The daemon that the docker CLI, which sind runs, reaches. sind supports only a daemon on this machine (see Docker host).
XDG_STATE_HOME The state directory, $XDG_STATE_HOME/sind/, else ~/.local/state/sind/: SSH files, realm locks, the activity log
XDG_RUNTIME_DIR Where sind ui records the running UI (see Troubleshooting)
XDG_CONFIG_HOME Where sind mcp claude and sind mcp vscode find the editor’s settings, $XDG_CONFIG_HOME/Claude/claude_desktop_config.json and $XDG_CONFIG_HOME/Code/User/mcp.json, else under ~/.config/ (see MCP)
NO_COLOR, TERM, COLORTERM The colours of the progress display and of log lines: NO_COLOR turns them off, and TERM=dumb writes plain text (see Progress Display)
LC_ALL, LC_CTYPE, LANG A UTF-8 locale draws the progress tree with Unicode marks, else ASCII
TRACEPARENT, TRACESTATE The W3C trace that the event log continues
SSH_CONNECTION, DISPLAY, WAYLAND_DISPLAY Whether sind ui --open can open a browser
Last updated on