CLI Commands
Command reference for the Throughwalls CLI.
The tables below list the available CLI commands and their command-specific flags.
These flags are available on all commands:
| Flag | Description |
|---|
| --help | Show help for a command. |
These flags are supported by most commands.
| Flag | Description |
|---|
| --ip <ip> | IP address of the Throughwalls host. |
| --recover-yes | Automatically answer Y when the CLI finds an interrupted command that must be recovered. |
| Command | Description |
|---|
| throughwalls--version | Print the CLI version. |
| Command | Description | Flags |
|---|
throughwalls connect | Connect to the Workspace. | --auto-start[=true|false]: start the Workspace automatically if it is powered off.--no-qga: connect to the Workspace even when the QEMU Guest Agent is disabled. Disables the user picker prompt.-u, --workspace-username <username>: Workspace username.-p, --workspace-password <password>: Workspace password.-k, --workspace-ssh-key <path>: path to the Workspace SSH private key.-s, --workspace-ssh-passphrase <passphrase>: passphrase for the Workspace SSH key. |
| Command | Description | Flags |
|---|
throughwalls goto <target> | Switch to a snapshot, base, or edge. | -u, --workspace-username <username>: Workspace username to use after the switch.-p, --workspace-password <password>: Workspace password to use after the switch.-k, --workspace-ssh-key <path>: Workspace SSH private key to use after the switch.-s, --workspace-ssh-passphrase <passphrase>: SSH key passphrase to use after the switch. |
| Command | Description | Flags |
|---|
throughwalls snap create | Create a new snapshot of the current Workspace. | --comment <comment>: snapshot comment.-n, --dry-run: show how many snapshots would be deleted if you created a snapshot now. No snapshot is created.-l, --line: used with --dry-run to show a detailed line diagram through a pager. |
throughwalls snap delete <id> | Delete a snapshot. | --delete-yes: skip the delete confirmation prompt. |
| Command | Description | Flags |
|---|
throughwalls line | Show the snapshot line. | None. |
throughwalls line head | Print the current head position. | None. |
| Command | Description | Flags |
|---|
throughwalls host login | Log in to the host. | -P, --host-password <password>: host password. |
throughwalls host password set [new-password] | Set a new host password. | None. |
| Command | Description | Flags |
|---|
throughwalls power host off | Shut down the host. | None. |
throughwalls power host reboot | Reboot the host. | None. |
throughwalls power host status | Show host power state. | None. |
throughwalls power workspace on | Start the Workspace. | None. |
throughwalls power workspace off | Shut down the Workspace. | -f, --force: use hard stop instead of graceful shutdown. |
throughwalls power workspace reboot | Reboot the Workspace. | None. |
throughwalls power workspace status | Show Workspace power state. | None. |
| Command | Description | Flags |
|---|
throughwalls config edit | Interactively walk through config fields. | None. |
throughwalls config set <key> <value> | Set a single config value. | None. |
throughwalls config get <key> | Read a single config value. | None. |
throughwalls config show | Print the entire config file. | None. |
throughwalls config path | Print the absolute path of the config file. | None. |
throughwalls config unset <key> | Clear a single config value. | None. |
| Command | Description | Flags |
|---|
throughwalls recover | Recover an interrupted command. | None. |
