Get started

Required prerequisites

Windows

1. Windows 11, 64-bit.
2. Windows Subsystem for Linux (WSL). Both container engines run in it. Sitting at the computer (not over a remote session), right-click Start, open Terminal (Admin), run the command below, then restart Windows.

   wsl --install --no-distribution

   --no-distribution skips the Ubuntu download, which Yawble does not need. wsl --status answers once WSL is installed.

3. Docker or Podman. Install Podman Desktop (recommended) or Docker Desktop and take the defaults.

macOS

1. Apple silicon (M1 or later). yawble does not run on Intel Macs.
2. Docker or Podman. Install Podman Desktop (recommended) or Docker Desktop and take the defaults.

Linux

1. 64-bit, Intel/AMD or ARM.
2. Podman or Docker Engine. Podman (recommended) runs rootless with no VM: your own memory and CPUs are the limit. Fedora Workstation already has it; on Fedora Server or another Fedora edition:

   sudo dnf install -y podman

   On Ubuntu or Debian:

   sudo apt install -y podman

   Docker Engine works too: follow Docker's instructions for your distribution and add yourself to the docker group. podman info or docker info answers once the engine is ready.

On any of them, the more memory the better. The first start proposes half of it, up to 12 GB, and asks before using it.

Install and start Yawble

These commands install the newest release of the yawble CLI.

Windows

In PowerShell:

& ([scriptblock]::Create((irm https://raw.githubusercontent.com/djlsystems/Yawble/main/cli/scripts/install.ps1)))

Open a new PowerShell window so yawble is on your path, then start it:

yawble up

macOS

In Terminal:

curl -fsSL https://raw.githubusercontent.com/djlsystems/Yawble/main/cli/scripts/install.sh | sh

Open a new Terminal window so yawble is on your path, then start it:

yawble up

Linux

In a terminal, as your own user (not root):

curl -fsSL https://raw.githubusercontent.com/djlsystems/Yawble/main/cli/scripts/install.sh | sh

It places yawble in ~/.local/bin, which Fedora and Ubuntu already put on your path; open a new terminal, then start it:

yawble up

If yawble is not found, the installer printed the line to add to ~/.profile. To reach the board from another computer on your network, use yawble remote enable tailscale (see Day to day below).

Then, on any of them

yawble up finds your container engine (and asks which one if you have both), pulls the images, starts Yawble and opens http://localhost:8080 in your browser. The first start installs the agent CLIs, which takes a few minutes; the starts after it are quick.

Port 8080 taken by another program? yawble up offers the next free one and remembers it. Anything else not right? yawble doctor checks the setup and --fix repairs what it can.

Create your account

The first account created is the owner, and registration closes behind it. Add more people under Admin, Users.

Connect your agents

Yawble runs Claude, Codex, Copilot and Grok. Use whichever you already have, in either of two ways:

• Your subscription. Open a Concierge on that agent in the board and sign in there, the same way you would on your desktop. The sign-in is kept on the data volume.
• An API key. Store it with the CLI, then restart:

yawble secret set ANTHROPIC_API_KEY
yawble up

The same works for OPENAI_API_KEY, XAI_API_KEY and, for Copilot, GH_TOKEN. For teams that work in GitHub repositories, yawble github walks you through a token. yawble agents shows which agents are signed in.

Put a team to work

Create a team, with a repository if the work is code or without one if it is research, writing or operations. Open the Concierge, tell it what you want done, and watch the board.

Day to day

Where to go next

• The documentation: how teams, triggers and the Concierge work.
• The repository: source, issues and releases.