Skip to Content
CLIJoin

Join a fleet

Ask the fleet owner for its join key, then run:

cmdop join <join-key>

Joining saves the credential for the selected relay and starts the background agent unless you pass --no-agent. Confirm the result with:

cmdop status

To join a specific relay:

cmdop join <join-key> --server https://relay.example.com

Use --display-name to choose the machine name shown to other operators, or --no-agent when service management will start the agent later.

cmdop join <join-key> --display-name build-box --no-agent cmdop start

Options

FlagPurpose
--server <url>Relay to join. Falls back to the active relay entry. --server-url is an alias.
--display-name <name>Name this machine shows to other operators.
--no-agentDo not start the agent after joining.
--machine-pin <pin>Per-machine connection PIN, when the relay owner has armed one for this machine.
--insecureSkip TLS verification. For a self-hosted relay with a self-signed certificate only.

If the relay has armed a connection PIN for this machine, present it so the agent can re-attach after a restart or a key rotation:

cmdop join <join-key> --machine-pin 4821

The relay owner arms and clears that PIN with cmdop server machine-pin.

A self-hosted relay on a LAN may also print a TLS pin at startup; --pin <hex> presents it. See Run a Cmdop relay for that setup.

Joining is the machine-onboarding path. The join key is a durable, multi-use shared secret the relay owner generates — it is not a token, an API key, or a one-time code. There is no separate browser or device-code login.

Last updated on