Get started

Yawble runs as one container on your own machine, managed by the yawble CLI. Your teams, documents and agent sign-ins live on a data volume, so upgrades never lose them.

Windows: Windows 11 with WSL. macOS: Apple silicon (M1 or later). Either way, the more memory the better: the container takes half of it, up to 12 GB.

1. Install a container engine

Install Podman Desktop (recommended) or Docker Desktop and take the defaults. Yawble sets up the rest.

On Windows, both need WSL. If it is missing, open Terminal as administrator, run the command below, and restart.

wsl --install --no-distribution

2. Install the CLI

Windows, in PowerShell:

irm https://raw.githubusercontent.com/djlsystems/Yawble-core/main/cli/scripts/install.ps1 | iex

macOS, in Terminal:

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

Open a new terminal afterwards so yawble is on your path.

3. Start it

yawble up

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

Port 8080 taken? yawble config set port 8081, then yawble up again. Anything else not right? yawble doctor checks the setup and --fix repairs what it can.

4. Create your account

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

5. 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.

6. 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

`yawble status`	Is it running, and on which version.
`yawble down`	Stop it. Your data stays on the volume.
`yawble update`	Update the CLI and move the instance to the new release.
`yawble logs -f`	Follow the container’s log.
`yawble remote enable tailscale`	Reach it from anywhere; `cloudflare` and `ngrok` work too.
`yawble uninstall`	Remove it. Add `--data` to delete the data volume too.

Where to go next

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