Install
Install the Workroom app, put the workroom command on your PATH, or install the CLI on its own.
Install the Mac app and you have everything: the workroom command-line tool is bundled inside it.
Install the app
You need macOS 15 Sequoia or later.
- Download the latest Workroom. Older versions are on the Releases page.
- Open the
.dmgand drag Workroom into Applications. - Open Workroom from Applications.
The app is signed and notarized by Apple, so it opens without a security warning. It updates itself in the background. To check for an update yourself, choose Workroom ▸ Check for Updates…. See Updates and channels.
The first time you open it, a short welcome walks you through what Workroom does and asks you to add your first project. You can skip that and add a project later from the sidebar.
Use the workroom command in your shell
You don't need the CLI to use the app. If you also want the workroom command in your own terminal:
- Choose Workroom ▸ Install ‘workroom’ Command in PATH….
- Enter your password if macOS asks for it.
This links the app's own copy of the command into your PATH, so the app keeps it up to date. See the
CLI reference for what it can do.
Install the CLI on its own
The CLI runs without the app, on macOS, Linux and Windows. It needs Git on your
PATH.
On macOS or Linux:
curl -fsSL https://raw.githubusercontent.com/joelmoss/workroom/master/install.sh | sh
On Windows, in PowerShell:
iwr https://raw.githubusercontent.com/joelmoss/workroom/master/install.ps1 -useb | iex
The installer picks the right build for your system and installs it to ~/.local/bin. If that folder
isn't on your PATH, it prints the line to add to your shell profile.
You can change what it installs with these variables:
| Variable | What it does |
|---|---|
WORKROOM_INSTALL_PATH |
Installs to another folder, such as /usr/local/bin. macOS and Linux only. |
VERSION |
Installs a specific version, such as v2.1.0. |
WORKROOM_CHANNEL |
pre installs the latest prerelease. nightly installs workroom-nightly. |
Set them in front of sh, so the installer sees them:
curl -fsSL https://raw.githubusercontent.com/joelmoss/workroom/master/install.sh | WORKROOM_CHANNEL=pre sh
A CLI installed this way updates itself with workroom update. See
Updates and channels.
You can also install it with Go:
go install github.com/joelmoss/workroom@latest
Optional: GitHub CLI
The app's pull request and CI panel uses the GitHub CLI, gh, version 2.57.0 or
later, signed in with gh auth login. Everything else works without it.