A local workspace for you and your AI agents. Usage guidance and examples live in the CLI overview.
Start or reuse Worktable and open it
worktable launch [options]
| Option |
Description |
-b, --background |
run as a managed background service |
-f, --foreground |
run in the foreground (Ctrl+C to stop) |
--no-browser |
do not open the browser |
-p, --port <port> |
port to listen on |
-H, --host <host> |
host interface to bind |
-w, --workspace <dir> |
workspace directory |
--reachable |
bind all interfaces so other machines can connect (web app behind owner password, MCP behind a token) |
--owner-password <pw> |
owner password to protect the web app when reachable (or set WORKTABLE_OWNER_PASSWORD) |
--behind-tls |
you front Worktable with HTTPS (a tunnel/proxy); suppresses the reachability reminder |
Configure workspace, background service, and agent connections
worktable setup [options]
| Option |
Description |
-y, --yes |
accept defaults without prompting |
-b, --background |
run as a managed background service |
-f, --foreground |
run in the foreground |
--skip-mcp |
skip agent connection setup |
--no-launch |
do not launch after setup |
--mcp <ids> |
comma-separated agent client ids to connect |
-w, --workspace <dir> |
workspace directory |
-H, --host <host> |
host interface to bind |
-p, --port <port> |
port to listen on |
--reachable |
bind all interfaces so other machines can connect (web app behind owner password, MCP behind a token) |
--owner-password <pw> |
owner password to protect the web app when reachable (or set WORKTABLE_OWNER_PASSWORD) |
--behind-tls |
you front Worktable with HTTPS (a tunnel/proxy); suppresses the reachability reminder |
Show server, workspace, service, and agent state
worktable status [options]
| Option |
Description |
--json |
machine-readable output |
Diagnose installation problems
worktable doctor [options]
| Option |
Description |
--check |
exit non-zero if the install is degraded |
Print resolved runtime paths
worktable paths [options]
| Option |
Description |
--json |
machine-readable output |
Export or import portable workspace snapshots
worktable workspace [command]
Export the configured workspace to a versioned snapshot
worktable workspace export <file> [options]
| Argument |
Description |
<file> |
destination .wtb file |
| Option |
Description |
Default |
--force |
replace an existing export file |
— |
--format <format> |
package format (wtb or legacy-json) |
wtb |
--history <mode> |
history to include (all, age, count, or none) |
all |
--history-days <days> |
days retained with –history age |
30 |
--history-count <count> |
versions per item with –history count |
50 |
Import a snapshot as a new independent workspace
worktable workspace import <file> <directory>
| Argument |
Description |
<file> |
source .wtb or legacy .wtb.json file |
<directory> |
missing or empty destination directory |
Manage the background service
worktable service [command]
Install the service
worktable service install [options]
| Option |
Description |
--json |
machine-readable output |
Start the service
worktable service start [options]
| Option |
Description |
--json |
machine-readable output |
Stop the service
worktable service stop [options]
| Option |
Description |
--json |
machine-readable output |
Restart the service
worktable service restart [options]
| Option |
Description |
--json |
machine-readable output |
Show service status (default subcommand)
worktable service status [options]
| Option |
Description |
--json |
machine-readable output |
Remove the service
worktable service uninstall [options]
| Option |
Description |
--json |
machine-readable output |
Print service logs
worktable service logs [options]
| Option |
Description |
-f, --follow |
stream new log lines |
-n, --lines <n> |
number of lines to show |
Connect coding agents on other machines
worktable agent [command]
Create a pairing code and print the one-line connect command
worktable agent invite [options]
| Option |
Description |
--client <id> |
agent client on the remote machine (claude-code, codex, cursor, opencode, vscode); omit to auto-detect there |
Redeem a pairing code on THIS machine and configure its agents
worktable agent connect <code-or-url> [options]
| Argument |
Description |
<code-or-url> |
pairing code from worktable agent invite or Settings -> Agents |
| Option |
Description |
--client <id> |
configure one specific client instead of the pairing’s choice |
--all |
configure every detected client |
--replace |
intentionally replace an existing Worktable client entry |
--server <origin> |
Worktable origin (needed when passing a bare code) |
Configure agent connections on this machine
Connect agents (auto-detects when no ids are given)
worktable mcp setup [clients...]
| Argument |
Description |
[clients...] |
client ids, e.g. codex cursor (or all) |
Disconnect an agent
worktable mcp remove <client>
| Argument |
Description |
<client> |
client id |
List supported agent clients
worktable mcp clients [options]
| Option |
Description |
--all |
include planned/experimental clients |
--json |
machine-readable output |
Show agent connection status (default subcommand)
worktable mcp status [options]
| Option |
Description |
--json |
machine-readable output |
Re-apply config for connected agents
Check whether the MCP endpoint is reachable
Print the MCP config snippet for a client
worktable mcp print-config <client> [options]
| Argument |
Description |
<client> |
client id |
| Option |
Description |
--with-token |
mint a scoped bearer and embed it (shown once) |
Manage Worktable agent skills on this machine
worktable skills [command]
Show Worktable skill installation status (default subcommand)
worktable skills status [targets...] [options]
| Argument |
Description |
[targets...] |
targets: claude, agents, or all |
| Option |
Description |
--json |
machine-readable output |
install Worktable skills in a target folder
worktable skills install <target> [options]
| Argument |
Description |
<target> |
target: claude or agents |
| Option |
Description |
--preview |
calculate the exact plan without changing files |
--plan-id <id> |
apply one previously reviewed exact plan |
-y, --yes |
apply without an additional prompt |
--json |
machine-readable output |
update Worktable skills in a target folder
worktable skills update <target> [options]
| Argument |
Description |
<target> |
target: claude or agents |
| Option |
Description |
--preview |
calculate the exact plan without changing files |
--plan-id <id> |
apply one previously reviewed exact plan |
-y, --yes |
apply without an additional prompt |
--json |
machine-readable output |
repair Worktable skills in a target folder
worktable skills repair <target> [options]
| Argument |
Description |
<target> |
target: claude or agents |
| Option |
Description |
--preview |
calculate the exact plan without changing files |
--plan-id <id> |
apply one previously reviewed exact plan |
-y, --yes |
apply without an additional prompt |
--json |
machine-readable output |
remove Worktable skills in a target folder
worktable skills remove <target> [options]
| Argument |
Description |
<target> |
target: claude or agents |
| Option |
Description |
--preview |
calculate the exact plan without changing files |
--plan-id <id> |
apply one previously reviewed exact plan |
-y, --yes |
apply without an additional prompt |
--json |
machine-readable output |
Update Worktable to the latest release
worktable update [version] [options]
| Argument |
Description |
[version] |
release version to install (default: latest) |
| Option |
Description |
--check |
check for a newer release without installing anything |
--background |
run as a detached worker that reports status to the server |
--status-file <path> |
path to the update-status marker (with –background) |
Remove Worktable from this machine (workspace preserved unless –purge)
worktable uninstall [options]
| Option |
Description |
-y, --yes |
skip the confirmation prompt |
--purge |
also permanently delete the workspace folder and all its contents |
Set up shell tab completion
worktable completion [command] <shell> [name]
| Argument |
Description |
<shell> |
shell to print a completion script for |
[name] |
binary name to complete |
Install completion for your shell (worktable and wtb)
worktable completion install [shell]
| Argument |
Description |
[shell] |
shell to target; default: detect from $SHELL |