CLI reference: sparkwing dashboard

CLI reference: sparkwing dashboard

Every sparkwing dashboard command, flag, and argument, generated from the CLI's own command registry. All command groups are indexed in cli-reference.md.

sparkwing dashboardSection anchor link

Manage the local dashboard

SubcommandsSection anchor link

  • install -- Install a dashboard service that starts at login
  • logs -- Read a bounded dashboard log tail
  • open -- Print a one-time sign-in link for the local dashboard
  • start -- Start the local dashboard and controller on demand
  • status -- Report whether the controller runs and where the dashboard serves
  • stop -- Stop a running dashboard server
  • uninstall -- Remove the dashboard login service

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.

sparkwing dashboard installSection anchor link

Install a dashboard service that starts at login

Install a login service with restart on failure using systemd user or launchd; no socket activation. Refuse Windows with --stay guidance.

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.
--forceReplace an existing object.

sparkwing dashboard logsSection anchor link

Read a bounded dashboard log tail

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.
--tail NNumber of most recent log lines to print, 40 by default; with --follow, lines before streaming starts.
-f, --followKeep streaming until the observed work finishes.

sparkwing dashboard openSection anchor link

Print a one-time sign-in link for the local dashboard

Print a one-time sign-in link for the local dashboard. When no dashboard serves, it first starts one at 127.0.0.1:4343, and the local controller too when none runs, whoever started the controller. The link is minted over the local socket, works once and expires after 60 seconds; visiting it gives that browser tab a session it sends as an Authorization bearer header, never a cookie. Every TCP API request needs that header; the local socket needs none.

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.

sparkwing dashboard startSection anchor link

Start the local dashboard and controller on demand

Starts the local controller on demand; --stay pins it until stopped. Runs, queued work, held leases, dashboard connections and a signed-in dashboard request in the last 30 minutes prevent idle exit.

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.
--addr HOST:PORTAddress the dashboard listens on as HOST:PORT, 127.0.0.1:4343 by default; a non-loopback host also needs --allow-remote.
--allow-remotePermit a non-loopback --addr over cleartext HTTP. The one-time login token and 24-hour session bearer cross the network unencrypted, and a session can read decrypted secrets. Use only on a trusted network or through an SSH tunnel: ssh -N -L 4343:127.0.0.1:4343 user@host (keep the remote dashboard on loopback).
--read-onlyBlock browser writes while still allowing authenticated reads of decrypted secrets and sign-out. This is not safe to share.
--stayKeep the local controller running until stopped.

sparkwing dashboard statusSection anchor link

Report whether the controller runs and where the dashboard serves

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.

sparkwing dashboard stopSection anchor link

Stop a running dashboard server

Stops the local controller and its dashboard. The dashboard no longer returns when a run or schedule next starts the controller; until this stop, a controller that exits idle and restarts on demand serves it again at the same address and read-only policy.

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.

sparkwing dashboard uninstallSection anchor link

Remove the dashboard login service

Remove the managed login service; Windows uses --stay only.

FlagsSection anchor link

FlagDescription
-o, --output FORMATPretty on a terminal; JSON when piped; explicit format wins. Values: pretty, json, plain.
-C, --checkout PATHResolve the project from this local checkout path.
-h, --helpShow command help without executing.
--help-allInclude uncommon flags in command help.