CLI command reference

A local workspace for you and your AI agents. Usage guidance and examples live in the CLI overview.

worktable launch

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

worktable setup

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

worktable status

Show server, workspace, service, and agent state

worktable status [options]

Option	Description
--json	machine-readable output

worktable doctor

Diagnose installation problems

worktable doctor [options]

Option	Description
--check	exit non-zero if the install is degraded

worktable paths

Print resolved runtime paths

worktable paths [options]

Option	Description
--json	machine-readable output

worktable workspace

Export or import portable workspace snapshots

worktable workspace [command]

worktable workspace export

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

worktable workspace import

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

worktable service

Manage the background service

worktable service [command]

worktable service install

Install the service

worktable service install [options]

Option	Description
--json	machine-readable output

worktable service start

Start the service

worktable service start [options]

Option	Description
--json	machine-readable output

worktable service stop

Stop the service

worktable service stop [options]

Option	Description
--json	machine-readable output

worktable service restart

Restart the service

worktable service restart [options]

Option	Description
--json	machine-readable output

worktable service status

Show service status (default subcommand)

worktable service status [options]

Option	Description
--json	machine-readable output

worktable service uninstall

Remove the service

worktable service uninstall [options]

Option	Description
--json	machine-readable output

worktable service logs

Print service logs

worktable service logs [options]

Option	Description
-f, --follow	stream new log lines
-n, --lines <n>	number of lines to show

worktable agent

Connect coding agents on other machines

worktable agent [command]

worktable agent invite

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

worktable agent connect

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)

worktable mcp

Configure agent connections on this machine

worktable mcp [command]

worktable mcp setup

Connect agents (auto-detects when no ids are given)

worktable mcp setup [clients...]

Argument	Description
[clients...]	client ids, e.g. codex cursor (or all)

worktable mcp remove

Disconnect an agent

worktable mcp remove <client>

Argument	Description
<client>	client id

worktable mcp clients

List supported agent clients

worktable mcp clients [options]

Option	Description
--all	include planned/experimental clients
--json	machine-readable output

worktable mcp status

Show agent connection status (default subcommand)

worktable mcp status [options]

Option	Description
--json	machine-readable output

worktable mcp repair

Re-apply config for connected agents

worktable mcp repair

worktable mcp test

Check whether the MCP endpoint is reachable

worktable mcp test

worktable mcp print-config

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)

worktable update

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)

worktable uninstall

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

worktable completion

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

worktable completion install

Install completion for your shell (worktable and wtb)

worktable completion install [shell]

Argument	Description
[shell]	shell to target; default: detect from $SHELL