Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .vitepress/data/commands.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@ aliases:
- ws
commands:
- name: ws-cli clip
since: 0.2.0
synopsis: Interact with the native clipboard
description: Reach the browser clipboard from the terminal over the workspace IPC socket.
commands:
- name: ws-cli clip paste
since: 0.2.0
synopsis: Paste clipboard content
description: Read the browser clipboard over the workspace IPC socket and write it to stdout — redirect it to a file or pipe it onward. Pairs with the pbcopy/xclip/xsel shims for terminal clipboard access.
usage: ws-cli clip paste
- name: ws-cli editor
since: next
synopsis: Inspect and drive the active editor session
description: Query and control the running VS Code / code-server window over the workspace IPC socket — list open tabs, read diagnostics and the current selection, or open a file. Blocked over SSH, where there is no browser editor to reach.
options:
Expand All @@ -21,17 +24,20 @@ commands:
usage: Output the raw JSON response without styling
commands:
- name: ws-cli editor diagnostics
since: next
synopsis: Show language diagnostics for the workspace (or a single file)
description: Pull language-server diagnostics (errors, warnings) from the editor over the IPC socket, across the whole workspace or a single file with --uri. Styled table by default, --raw for the JSON.
usage: ws-cli editor diagnostics [flags]
options:
- name: uri
usage: Filter to a single file (URI or absolute path)
- name: ws-cli editor list
since: next
synopsis: List the currently open editor tabs
description: List the editor's open tabs over the IPC socket, with each tab's path, language, and active or dirty state.
usage: ws-cli editor list
- name: ws-cli editor open
since: next
synopsis: Open a file in the editor
description: Open a file in the running editor window over the workspace IPC socket — a tab in the current window by default, a separate one with --new-window, jumping to a range with --selection. Fails fast over SSH, where there is no browser editor to open into.
usage: ws-cli editor open <file> [flags]
Expand All @@ -48,21 +54,25 @@ commands:
- name: selection
usage: 'Select a range: LINE:COL[-LINE:COL] (1-based)'
- name: ws-cli editor selection
since: next
synopsis: Show the active editor's current selection
description: Report the active editor's current selection — file, range, and selected text — over the IPC socket. Empty when nothing is selected.
usage: ws-cli editor selection
- name: ws-cli feature
since: 0.2.0
synopsis: Install additional pre-configured features
description: Install and inspect optional workspace features — Ansible playbooks that add tools on top of the base image. Ships a curated set; --root points at your own under ~/.ws/features.d.
options:
- name: root
usage: Root directory of additional features
commands:
- name: ws-cli feature info
since: 0.2.0
synopsis: Show detailed information about a feature
description: Show a feature's description and the variables it accepts, so you know what --opt values install will take.
usage: ws-cli feature info <name>
- name: ws-cli feature install
since: 0.2.0
synopsis: Install additional pre-configured features
description: Run a feature's playbook to install it. Pass variables with --opt KEY=VAL, and skip parts you do not want with --skip-extensions, --skip-completion, or --skip-repository.
usage: ws-cli feature install [flags]
Expand All @@ -80,12 +90,14 @@ commands:
default: "false"
usage: Skip enabling the vendor APT repository
- name: ws-cli feature list
since: 0.2.0
synopsis: List available features that can be installed
description: List the features you can install, marking where each comes from — the shipped set, a workspace override, or your own ~/.ws/features.d.
usage: ws-cli feature list
aliases:
- ls
- name: ws-cli feature new
since: 0.2.0
synopsis: Print boilerplate for a custom feature playbook
description: |-
Print a starter feature playbook to stdout.
Expand All @@ -96,22 +108,27 @@ commands:
ws-cli feature new redis > ~/.ws/features.d/redis.yaml
usage: ws-cli feature new [name]
- name: ws-cli feature store
since: 0.2.0
synopsis: List packages available in the feature store
description: List the artifacts published to the feature store (WS_FEATURES_STORE_URL) — the offline mirror features install from when the network is locked down.
usage: ws-cli feature store
- name: ws-cli info
since: 0.2.0
synopsis: Display workspace information
description: Report facts about the running workspace — version, effective environment, installed extensions, live resource metrics, and uptime.
commands:
- name: ws-cli info env
since: 0.2.0
synopsis: Display effective workspace environment variables
description: Print every WS_* variable in effect, sorted — the resolved environment the workspace booted with.
usage: ws-cli info env
- name: ws-cli info extensions
since: 0.2.0
synopsis: Display installed extensions
description: List the installed VS Code extensions with their versions.
usage: ws-cli info extensions
- name: ws-cli info metrics
since: 0.2.0
synopsis: Display workspace metrics
description: Show live resource usage — CPU, memory, disk, and file descriptors, plus GPU with --gpu.
usage: ws-cli info metrics [flags]
Expand All @@ -120,10 +137,12 @@ commands:
default: "false"
usage: Include GPU metrics
- name: ws-cli info uptime
since: 0.2.0
synopsis: Display the workspace uptime
description: Show when the workspace session started and how long it has been running.
usage: ws-cli info uptime
- name: ws-cli info version
since: 0.2.0
synopsis: Display installed workspace version
description: Print the workspace version. --all expands to the full table — workspace, ws-cli, and VS Code.
usage: ws-cli info version [flags]
Expand All @@ -132,6 +151,7 @@ commands:
default: "false"
usage: Show all version information
- name: ws-cli log
since: 0.2.0
synopsis: Log messages
description: Emit styled, level-tagged log lines — the same formatting the startup scripts use. --pipe runs each line of piped input through the logger.
options:
Expand All @@ -141,6 +161,7 @@ commands:
usage: Loop through piped output
commands:
- name: ws-cli log debug
since: 0.2.0
synopsis: Log debugging messages
description: Emit a log line at debug level in the workspace style — the same formatting the startup scripts use. --indent nests it under a preceding line, --stamp prefixes a timestamp.
usage: ws-cli log debug message [flags]
Expand All @@ -154,6 +175,7 @@ commands:
default: "false"
usage: Prefix message with current timestamp
- name: ws-cli log error
since: 0.2.0
synopsis: Log error messages
description: Emit a log line at error level in the workspace style — the same formatting the startup scripts use. --indent nests it under a preceding line, --stamp prefixes a timestamp.
usage: ws-cli log error message [flags]
Expand All @@ -167,6 +189,7 @@ commands:
default: "false"
usage: Prefix message with current timestamp
- name: ws-cli log info
since: 0.2.0
synopsis: Log information messages
description: Emit a log line at info level in the workspace style — the same formatting the startup scripts use. --indent nests it under a preceding line, --stamp prefixes a timestamp.
usage: ws-cli log info message [flags]
Expand All @@ -180,10 +203,12 @@ commands:
default: "false"
usage: Prefix message with current timestamp
- name: ws-cli log stamp
since: 0.2.0
synopsis: Log the current timestamp
description: Print just the current timestamp in the workspace log style — handy for marking phases in a startup log.
usage: ws-cli log stamp
- name: ws-cli log warn
since: 0.2.0
synopsis: Log warning messages
description: Emit a log line at warn level in the workspace style — the same formatting the startup scripts use. --indent nests it under a preceding line, --stamp prefixes a timestamp.
usage: ws-cli log warn message [flags]
Expand All @@ -197,6 +222,7 @@ commands:
default: "false"
usage: Prefix message with current timestamp
- name: ws-cli logs
since: 0.2.0
synopsis: Retrieve workspace logs
description: Read a workspace daemon's log — the main log by default, or --target metrics|docker|auth_proxy|cloudflared. Filter by --level, limit with --tail, or stream live with --follow.
usage: ws-cli logs [flags]
Expand All @@ -216,6 +242,7 @@ commands:
default: main
usage: Log target to read (main|metrics|docker|auth_proxy|cloudflared)
- name: ws-cli secrets
since: 0.2.0
synopsis: Manage encryption and decryption of secrets
description: 'Encrypt and decrypt values under a master key, and generate the keys themselves. Encrypted values are what the seed engine''s secrets: map stores and decrypts at boot.'
options:
Expand All @@ -233,22 +260,27 @@ commands:
usage: Output without styling
commands:
- name: ws-cli secrets decrypt
since: 0.2.0
synopsis: Decrypt an encrypted value
description: Decrypt a value produced by encrypt, under the master key. Reads from the argument or stdin (-); writes the plaintext to stdout, or a file with --output.
usage: ws-cli secrets decrypt <encrypted|->
- name: ws-cli secrets encrypt
since: 0.2.0
synopsis: Encrypt a plaintext value
description: Encrypt a value under the master key. Reads the plaintext from the argument or stdin (-); writes the ciphertext to stdout, or a file with --output.
usage: ws-cli secrets encrypt <plaintext|->
- name: ws-cli secrets generate
since: 0.2.0
synopsis: Generate master keys or login password hashes
description: Generate the credentials the workspace needs — a master key for secrets, or a login password hash for the server.
commands:
- name: ws-cli secrets generate login
since: 0.2.0
synopsis: Generate a workspace password hash for authentication
description: Prompt for a password and print its hash for the workspace server login (WS_AUTH_PASSWORD_HASHED). Store the hash, never the password.
usage: ws-cli secrets generate login
- name: ws-cli secrets generate master
since: 0.2.0
synopsis: Generate a cryptographically secure master key
description: Generate a random master key, printed base64-encoded — the key encrypt, decrypt, and the seed engine use. --length sets the byte size (default 32).
usage: ws-cli secrets generate master [flags]
Expand All @@ -257,13 +289,15 @@ commands:
default: "32"
usage: Key length in bytes
- name: ws-cli seed
since: next
synopsis: Project declarative content onto the filesystem
description: Copy files and apply small edits from a seed source onto the filesystem at boot. Bare files mirror verbatim; a .seed.yaml manifest overlays behavior — copy, merge, append — and decrypts secrets under the master key. Point --source at a mounted volume to seed a container from durable storage.
options:
- name: source
usage: Seed source directory
commands:
- name: ws-cli seed apply
since: next
synopsis: Project seed content onto the filesystem
description: Apply the seed source to the filesystem — mirror bare files and run the .seed.yaml operations. Writes only where the destination is missing unless --force; pass destinations to limit the run to those paths.
usage: ws-cli seed apply [dest...] [flags]
Expand All @@ -274,10 +308,12 @@ commands:
- name: master
usage: Master key or path to key file
- name: ws-cli seed ls
since: next
synopsis: List seed destinations and their behaviors
description: List what apply would write — each destination with its operation and whether it carries a secret or a template — without touching the filesystem.
usage: ws-cli seed ls
- name: ws-cli seed rotate
since: next
synopsis: Re-encrypt managed secrets under a new master key
description: 'Re-encrypt every managed secret from the old master key (--master) to a new one (--new-master), in place. All-or-nothing: it verifies every secret decrypts before writing anything.'
usage: ws-cli seed rotate [flags]
Expand All @@ -287,6 +323,7 @@ commands:
- name: new-master
usage: New master key or path to key file
- name: ws-cli serve
since: 0.2.0
synopsis: Serve internal assets
description: Run a small HTTP server for local assets — fonts or the current directory — on --port (default 38080).
options:
Expand All @@ -299,22 +336,27 @@ commands:
usage: Port to serve assets on
commands:
- name: ws-cli serve current
since: 0.2.0
synopsis: Serve current directory as a static site
description: Serve the current directory over HTTP as a static site — a quick way to preview built files.
usage: ws-cli serve current
- name: ws-cli serve current
since: 0.2.0
synopsis: Serve current directory as a static site
description: Serve the current directory over HTTP as a static site — a quick way to preview built files.
usage: ws-cli serve current [flags]
- name: ws-cli serve font
since: 0.2.0
synopsis: Serve fonts for local download
description: Serve the installed fonts over HTTP so a browser can fetch them for local install.
usage: ws-cli serve font
- name: ws-cli serve font
since: 0.2.0
synopsis: Serve fonts for local download
description: Serve the installed fonts over HTTP so a browser can fetch them for local install.
usage: ws-cli serve font [flags]
- name: ws-cli serve metrics
since: 0.2.0
synopsis: Start the Prometheus metrics server
usage: ws-cli serve metrics [flags]
options:
Expand All @@ -326,6 +368,7 @@ commands:
default: "9100"
usage: Port to serve metrics on
- name: ws-cli show
since: 0.2.0
synopsis: Display information about the current workspace instance
description: Resolve and print facts about this workspace instance — settings, IP addresses, and paths. --raw drops the styling for use in scripts.
options:
Expand All @@ -334,6 +377,7 @@ commands:
usage: Output raw value without styling
commands:
- name: ws-cli show env
since: 0.2.0
synopsis: Display the resolved value of a workspace environment variable
description: Resolve a setting by its dotted key (server.port) and print it with its source and description. --value emits just the value for scripts, --as bool|int|list validates the shape, --check tests whether it is set so a startup script can guard on it.
usage: ws-cli show env <KEY> [flags]
Expand All @@ -356,26 +400,32 @@ commands:
default: "false"
usage: Emit the raw resolved value as a single line
- name: ws-cli show ip
since: 0.2.0
synopsis: Display IP addresses
description: Print the workspace's IP addresses — the internal container address or the node it runs on.
commands:
- name: ws-cli show ip internal
since: 0.2.0
synopsis: Display the internal IP address
description: Print the workspace container's internal IP address.
usage: ws-cli show ip internal
- name: ws-cli show ip node
since: 0.2.0
synopsis: Display the node/host IP address
description: Print the IP address of the node hosting the workspace.
usage: ws-cli show ip node
- name: ws-cli show path
since: 0.2.0
synopsis: Display various paths
description: Print well-known workspace paths — the home root or the VS Code settings file.
commands:
- name: ws-cli show path home
since: 0.2.0
synopsis: Display the workspace home path
description: Print the workspace home (server root) path.
usage: ws-cli show path home
- name: ws-cli show path vscode-settings
since: 0.2.0
synopsis: Display the VS Code settings path
description: Print the path to the VS Code settings file — the user file by default, or the folder's with --workspace.
usage: ws-cli show path vscode-settings [flags]
Expand All @@ -384,10 +434,12 @@ commands:
default: "false"
usage: Get the workspace settings
- name: ws-cli template
since: 0.2.0
synopsis: Manage static configuration files
description: Copy shared configuration files (linters, formatters) from their global locations into a project, and inspect what they hold.
commands:
- name: ws-cli template apply
since: 0.2.0
synopsis: Apply a configuration template to the current project
description: Copy a template into the project — a shared config like ruff or markdownlint — to --path (the current directory by default). --force overwrites an existing file.
usage: ws-cli template apply <template> [flags]
Expand All @@ -400,12 +452,14 @@ commands:
default: .
usage: Target directory path
- name: ws-cli template list
since: 0.2.0
synopsis: List all available configuration templates
description: List the templates you can apply, with their source paths and whether one is already applied here.
usage: ws-cli template list
aliases:
- ls
- name: ws-cli template show
since: 0.2.0
synopsis: Display the contents of a configuration template
description: |-
Display the contents of a configuration template.
Expand Down
Loading
Loading