CLI reference / network / up

stado network up

Invocation

stado network up [OPTIONS]

Purpose

Join this host to Stado's network: mint its key, measure its endpoints, declare its node in the registry with its network address as the preferred SSH path, install and start the node, and see it answer

Required inputs and options

Input or optionContract
--host <HOST>The registry host this is; this machine's own registry entry when omitted
--endpoint <HOST:PORT>A reachable `host:port` peers on other networks dial (a port this host's router forwards to the node, or a public address). Repeatable
--no-directDeclare none of the endpoints measured on this host's interfaces: a host behind NAT that peers reach through a relay only
--relayRelay for hosts peers cannot dial. A relay needs an endpoint every host can reach
--attach-retry-seconds <SECONDS>With --relay: how long a node whose attachment to this relay ended waits before attaching again
--jsonEmit machine-readable output

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

  • Relay for hosts peers cannot dial.
  • 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.