Skip to content
Workloom
Menu

Get started

Get started

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

Sign upRead the docs
  1. Step 1

    Sign up

    Create an account in the dashboard. Signing up bootstraps you into an organization.

  2. Step 2

    Create a workspace

    Under Workspaces, create a workspace, pick its providers and pin package versions. 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 ~/.local/bin.

  4. Step 4

    Bind and pull

    Point the CLI at your registry API with WORKLOOM_API_URL and authenticate: export an API token as WORKLOOM_DEV_TOKEN, or run `wl auth login --issuer <url> --client-id <id>` (OIDC device flow). Then run `wl bind --registry <workspaceId>`, `wl pull --dry-run` to see the render plan, and `wl pull`.

What you need

  • A dashboard account in an organization
  • The URL of your registry API, set as WORKLOOM_API_URL for the CLI
  • An API token, or an OIDC issuer and client id for `wl auth login`
  • A repository that uses Claude Code or Codex

Install the CLI

curl -fsSL https://raw.githubusercontent.com/catesandrew/workloom-releases/main/scripts/install.sh | bash

Prebuilt binaries exist for macOS (Apple silicon and Intel), Linux (x64 and arm64) and Windows (x64). The current published build is a test release, cli-v0.1.0-test4. The CLI is not published to npm or Homebrew; set WL_VERSION to pin a release tag.

Releases and installer source →

The desktop app

The desktop app is built with Tauri. The release pipeline builds a macOS .app for Apple silicon; Windows and Linux builds are turned off in CI, and the only published desktop build is an early test release (desktop-v0.1.0-test1). Windows and Linux builds are unsigned.