CLI reference / stream / declare

stado stream declare

Invocation

stado stream declare [OPTIONS] <TARGET>

Purpose

Declare that this host carries an interactive session, in the registry

Required inputs and options

Input or optionContract
<TARGET>Positional input; required or optional as shown in the invocation.
--resolution <RESOLUTION>Virtual screen size the client receives, `WIDTHxHEIGHT` [default: 2560x1440]
--refresh-hz <REFRESH_HZ>[default: 60]
--gpu-uuid <GPU_UUID>Driver UUID of the board that renders. Omitted leaves the driver's default, which is the board the job agent also prefers
--library-dir <LIBRARY_DIR>Directory for large client data on a volume that has room [default: /mnt/wisent-games]
--steamInstall Steam beside the session
--sunshine-url <SUNSHINE_URL>Pin a Sunshine artifact explicitly, for a distribution this build has no measured digest for. Requires `--sunshine-sha256`
--sunshine-sha256 <SUNSHINE_SHA256>sha256 of that artifact, measured, never guessed
--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

  • Requires `--sunshine-sha256`
  • 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.