Install Worktable from the CLI
Use the command-line install for Linux, Intel Macs, servers, or when you prefer to run Worktable as a local service. On an Apple Silicon Mac, the native Desktop app is the simplest starting point. If you do not want to operate a machine or server, use Worktable Cloud.
curl -fsSL https://worktable.dev/install | shThe installer supports macOS and Linux on arm64 and x64. It sets up the
worktable command (with a wtb shorthand), then starts interactive setup.
When setup finishes, open the address it prints. The default is:
http://localhost:7480See it before you run it
Section titled “See it before you run it”Piping a script to sh deserves skepticism. The installer is short, needs no
sudo, and edits no shell profiles. See exactly what it would download and touch:
curl -fsSL https://worktable.dev/install | sh -s -- --dry-runEvery flag and default path is listed in the installer reference.
Choose the workspace folder
Section titled “Choose the workspace folder”Your workspace is a plain folder at ~/Worktable by default. Docs, HTML docs,
records, annotations, threads, and history remain separate from app settings
and credentials.
Pick another folder during setup, or steer it explicitly:
worktable setup --workspace ~/work/notebookWORKTABLE_WORKSPACE=~/work/notebook worktableWorktable can adopt an existing valid workspace. It refuses to initialize a non-empty unrelated folder or overwrite an unfamiliar workspace identity.
Choose how it runs
Section titled “Choose how it runs”Interactive setup offers a managed background service or a foreground process. The background service is convenient for agents that should reach Worktable after the terminal closes. Foreground mode keeps lifecycle control in the current terminal.
To make a server reachable from another machine, finish the local setup first, then follow Reach Worktable from another machine.
Verify the install
Section titled “Verify the install”worktable doctordoctor checks the installation and reports the active workspace, service, and
agent setup.
Non-interactive installs
Section titled “Non-interactive installs”# Accept defaults without promptscurl -fsSL https://worktable.dev/install | sh -s -- --yes
# Install only; run setup yourself latercurl -fsSL https://worktable.dev/install | sh -s -- --no-setupYou can also supply --workspace, --port, --background or --foreground,
and --mcp <client-ids> in the same pass. See the
installer reference for every flag and path.