Skip to content
Workloom
Menu

Get started

Get started

Workloom is pre-launch: the only published binaries are a test build. Here is the honest path from zero to a rendered, drift-checked workspace.

Sign upRead the docs
  1. Step 1

    Get the CLI

    Install the test build of `wl` with the script below (macOS on Apple silicon, Linux x64 and arm64), download the Windows x64 binary from the releases page, or run `pnpm wl <command>` from a source checkout.

  2. Step 2

    Describe a workspace

    Run `wl init` in a repository and edit the targets in workloom.workspace.json. `wl render` and `wl sync` read package content from a local package directory (--fixtures, default fixtures/).

  3. Step 3

    Validate, render, sync

    Run `wl validate`, then `wl render --dry-run` to read the plan, then `wl sync` to write it. Add `wl sync --check` to CI.

  4. Step 4

    Connect a registry

    Create an account in the web console, run `wl login` with a personal access token (wl_…), and set WORKLOOM_REGISTRY_URL so `wl bind`, `wl pull`, `wl push` and `wl status` use the registry API.

What you need

  • macOS (Apple silicon), Linux (x64 or arm64) or Windows (x64) for the test build; Node.js 22 or newer and pnpm to run from source
  • Claude Code, Codex, GitHub Copilot or Gemini to read the files Workloom writes
  • A Workloom registry and a personal access token, only for the registry commands

Install the test build

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

The installer downloads the latest release from the public releases repository, checks it against SHA256SUMS and installs `wl` to ~/.local/bin (set WL_INSTALL_DIR to change that, or WL_VERSION to pin a tag). The only release there is a test build, v0.0.0-test.1, with CLI binaries for macOS (Apple silicon), Linux (x64, arm64) and Windows (x64); there is no Intel macOS binary. On Windows, download wl-windows-x64.exe from the releases page. The CLI binaries are not signed with a Developer ID, so a browser-downloaded copy needs its quarantine flag cleared on macOS or "Run anyway" on Windows. The CLI is not published to npm or Homebrew.

Releases and installer source →

The desktop app

The desktop app (Tauri) signs you in and runs the workspace operations on bound folders: status, diff, render, sync and restore. The test release includes Workloom.app.zip for macOS (Developer ID signed and notarized), AppImage and .deb packages for Linux and a Windows installer; those Linux and Windows builds are unsigned, and the current release workflow builds macOS only.