Skip to content
Workloom
Menu

Get started

Get started

Create an organization and a workspace in the dashboard, then bind a directory to it with the `wl` CLI and pull.

Sign upRead the docs
  1. Step 1

    Sign up

    Create an account in the dashboard. Onboarding creates your organization and its first membership.

  2. Step 2

    Create a workspace

    Create a workspace, add its workspace targets, pick providers and set version constraints. Copy its id.

  3. Step 3

    Install wl

    Run the installer from the public releases repository. It downloads the prebuilt `wl` binary for your platform, checks its SHA-256 checksum and installs it to ~/.workloom/bin.

  4. Step 4

    Bind and pull

    Point the CLI at your registry with `--registry-url <url>` or registry_url in ~/.config/workloom/config.toml, then run `wl login` (device authorization flow), `wl bind --workspace <id>`, `wl pull --dry-run` to see the plan, and `wl pull`.

What you need

  • A dashboard account in an organization
  • The URL of your Workloom registry API (the CLI defaults to http://localhost:3001)
  • A repository or home directory that uses Claude Code, Codex or Gemini

Install the CLI

curl -fsSL https://raw.githubusercontent.com/catesandrew/work-loom-releases/main/packaging/install.sh | VERSION=cli-v0.1.0-test2 sh

Prebuilt binaries exist for macOS (Apple silicon and Intel), Linux (x64 and arm64) and Windows (x64); the current build is a test release, cli-v0.1.0-test2. Pin VERSION as shown: the newest release in that repository is a desktop build, so the installer’s “latest” lookup finds no `wl` binary. The CLI is not published to npm.

Releases and installer source →

The desktop app

The desktop app is built with Tauri. Its release pipeline builds a macOS .app (Apple silicon and Intel), a Linux AppImage and .deb, and a Windows installer. The only published build is a test release, desktop-v0.1.0-test3, in the public releases repository.