CLI reference / fleet / enroll

stado fleet enroll

Invocation

stado fleet enroll [OPTIONS] --ssh <SSH> <NAME>

Purpose

One-command onboarding: register a machine, optionally fleet it, optionally install the agent

Required inputs and options

Input or optionContract
<NAME>Machine name (a lowercase target identifier)
--ssh <SSH>SSH destination of the machine (user@host) — the verification channel; the machine is probed before anything is written
--kind <KIND>Target kind [default: local]
--fleet <FLEET>Fleet to place the machine in right away
--install-keyInstall the fleet's public key into the machine's ~/.ssh/authorized_keys before probing it — the `adopt` method. Use this for a machine that is not in the fleet yet, whenever you can already open an SSH session to it some other way (a loaded ssh agent, one of your own keys, or the account password, which OpenSSH asks for itself). Without it, enroll assumes the fleet's key is already in authorized_keys there
--bootstrapInstall the agent on the machine after registering it

Output and state effect

It performs the operation described above and emits its operator result on standard output or standard error. Any state change is limited to the resources and records named by the purpose and options on this page.

Refusals

  • Before dispatch, Stado refuses a missing required token shown in the invocation, an unknown option, or a value outside a listed value set; argument-usage failures exit with code 2.