CLI reference / service / onboarding

stado service onboarding

Invocation

stado service onboarding [OPTIONS] --host <HOST> --product-id <PRODUCT_ID> --display-name <DISPLAY_NAME> --repository <REPOSITORY> --first-success-fact <FIRST_SUCCESS_FACT> <NAME>

Purpose

Attach central onboarding product metadata to a managed service. The metadata becomes part of the canonical Stado registry and is emitted by `service list --json` for Echo catalog synchronization.

Required inputs and options

Input or optionContract
<NAME>Service name, launchd label, or systemd unit
--host <HOST>Registry host that declares the service
--product-id <PRODUCT_ID>Command option; required or optional as shown in the invocation.
--display-name <DISPLAY_NAME>Command option; required or optional as shown in the invocation.
--repository <REPOSITORY>Command option; required or optional as shown in the invocation.
--surfaces <SURFACES>...Command option; required or optional as shown in the invocation.
--first-success-fact <FIRST_SUCCESS_FACT>Command option; required or optional as shown in the invocation.
--onboarding-kind <ONBOARDING_KIND>[default: both]
--status <STATUS>[default: active]
--jsonCommand option; required or optional as shown in the invocation.

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.