wsctl command reference

Page in progress

The detailed command reference is being rebuilt for v0.5. The supported way to install and operate Waveshift is to run wsctl with no arguments — the bubbletea TUI walks you through every flow. Until the full reference lands:

• Deploy walkthrough covers the deploy flow.
• Console tour covers everything that's done from the Console after deploy.
• Common issues covers the edges.

Command summary

Every TUI flow also has a plain command, for scripting or when a terminal can't host the TUI. Run any command with --help for its flags and examples.

Command	What it does
wsctl	Launch the TUI (--no-tui prints help instead)
wsctl config init / waveshift / kasm / show	Write or display wsctl.json settings
wsctl deploy infrastructure / waveshift / kasm / all	Deploy components (--dry-run to preview)
wsctl destroy waveshift / kasm / infrastructure / all	Tear components down (--yes to skip the prompt)
wsctl status	Show deployment status (--json)
wsctl health-check	Check service health through the proxies (--target, --wait, --timeout)
wsctl proxy start / stop / status	SSM port-forwards — Console on https://localhost:8443, Kasm on https://localhost:8444
wsctl connect <target>	SSM shell on waveshift, kasm, or an Infrastructure Server by number or site ID (--root)
wsctl node-site list / create / destroy / deregister	Manage Site + Infrastructure Server pairs (alias ns)
wsctl hub detect / configure <site> / upgrade / connect	Detect, configure, flash, or SSH into a Hub router
wsctl cert status / export / rotate	Check, export, or reissue the deployment's certificates
wsctl completion <shell>	Shell completion for bash, zsh, fish, or PowerShell
wsctl version	Print version and build information

See also

• wsctl — overview of the CLI.
• Configuration — the wsctl.json reference.
• Defaults — every value baked into a stock deploy.