Skip to content
Workloom
Menu

Get started

Get started

Workloom is early: the CLI runs from a source checkout today, and prebuilt binaries exist only as test releases. Here is the honest path from zero to rendered files.

Sign upRead the docs
  1. Step 1

    Get the CLI

    From a source checkout, `pnpm install` and then `pnpm wl <command>` runs the CLI. A test build of the `wl` binary is also available from the public releases repository (below).

  2. Step 2

    Try a fixture workspace

    Run `wl validate`, `wl render --dry-run` and `wl sync --check` against fixtures/workspaces/simple-workspace.json to see a render plan and a drift check without touching your files.

  3. Step 3

    Sign in to a registry

    Run `wl login --registry-url <url>` to start a device login against your registry API, or create an account in the dashboard.

  4. Step 4

    Install a package

    `wl install <package>` adds a package to your home workspace and syncs it. `wl list` shows what is installed and `wl doctor` checks trust and drift.

What you need

  • Node.js and pnpm to run from source
  • The URL of a Workloom registry API for `wl login`
  • Claude Code, Codex or GitHub Copilot to read the files Workloom writes

Install the test build

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

The installer downloads the newest cli-v* release from the public releases repository, checks it against SHA256SUMS and installs it to ~/.workloom/bin (set WL_INSTALL_DIR to change that). The only published CLI release is a test build, cli-v0.1.0-test4, with binaries for macOS (Apple silicon), Linux (x64) and Windows (x64); the current release workflow builds macOS (Apple silicon) only. The CLI is not published to npm or Homebrew.

Releases and installer source →

The desktop app

The desktop app (Tauri) is a sign-in shell today: a device-code login around a bundled Node sidecar. The public releases repository has test builds only (latest desktop-v0.1.0-test3, for macOS, Linux and Windows); signing is optional and builds without signing secrets are unsigned.