Yard for desktop
Use your own Mac or Windows PC as your Yard runner, with an app that sets it up, shows what it does, and lets you decide what Yard may do on it.
Yard for desktop turns the computer you work on into your own runner: your workspaces, their files and the agents working in them run on it, not on a server. There is no terminal to open and nothing to install by hand.
Download and set up
- In Yard, open Runners → Register runner and press the download for your system (it is listed first), or get it from this page's links.
- Open the app and press Sign in to Yard. Your browser opens; confirm the code there. No account yet? Make one on the same page.
- Get this computer ready. The app checks what the computer has: room to work, free disk space, Git, a container engine, and on Windows WSL 2 and virtualization. Anything missing has an Install button. Nothing is installed until you press it, and your computer may ask once for an administrator.
- Choose a folder for your workspaces (
~/.yardon a Mac,%USERPROFILE%\yardon Windows unless you pick another) and press Continue. The app registers the computer as your personal runner (only you can put workspaces on it) and starts it in the background. - Create a workspace on it, from the app or in Yard, and work as usual.
Yard keeps running in the background after you close the window, and starts with your computer. Quitting the app from its tray icon closes the window only: your workspaces stay online.
Mac
Docker Desktop is downloaded for your processor (Apple silicon or Intel) and copied to Applications; it asks for your password once to finish, and to accept its terms. OrbStack, Colima and Rancher Desktop work too, if you have one already. While Yard runs the Mac does not idle to sleep; closing the lid still sleeps it, and Yard reconnects on wake.
Windows
Docker Desktop, Git and WSL are installed with winget; Windows asks for an
administrator. After installing WSL, restart when Windows asks. If the app
says virtualization is off, see YRD-VIRT-001.
Linux
Linux has an AppImage; the yard CLI is the usual
way there. The app installs Docker Engine with get.docker.com through your
desktop's password prompt.
Already ran yard runner up here?
The app finds a runner the CLI installed on this computer and offers Manage it here, rather than installing a second one.
What Yard may do on this computer
Yard's servers send your runner its work: create a workspace, start an agent, open a terminal. On your own computer you decide how much of that needs your yes, under Privacy & control:
| Level | What waits for you |
|---|---|
| Ask me first | New workspaces, terminals opened by anyone but you, every agent sign-in, and agent turns and test runs started by anyone but you (or by Yard itself). |
| Workspaces I approved (the app's default) | New workspaces, terminals opened by anyone but you, and every agent sign-in. Agents work in approved workspaces without asking. |
| Anything my organization sends | Nothing: everything runs, as on a server. |
- Requests that wait show in the app (and as a notification). Allow or Don't allow; after 5 minutes without an answer the request fails, and the person who asked sees "Waiting for the owner of this computer to approve".
- Pause stops anything new from starting (agents, terminals, tests, previews). Your files stay readable in Yard. Teammates see "Paused by its owner" on the runner.
- Remove from this computer takes a workspace off the allowlist: every request for it is refused from then on.
- Activity lists everything Yard asked this computer to do: what, for which workspace, who asked and how it ended. Never file contents. It stays on this computer.
- Only you, on this computer, can change any of this. Yard has no way to: the
setting is kept in the runner's own folder and changed only through the
app (or
yard runner config set control).
Agents always work inside containers, with only the workspace's folder in reach. Running without containers is possible but not recommended: the app says what it gives up and asks you to confirm.
What this does not cover: who asked is what Yard's servers say. A server that lied about it could get past "anyone but you". See the runner's trust model for the details.
Updates
By default the app updates itself and the runner without asking. A new version is checked every 6 hours, downloaded in the background, and installed while no agent is working (at the latest after 24 hours, once running work finishes; new work waits for those few minutes). Only versions signed by Yard are installed. If a new version does not come online within 2 minutes, the previous one is put back (YRD-UPDATE-001). Help & logs lists past updates.
To decide yourself when to update, turn off Automatic updates in Help &
logs (or run yard runner config set auto-update off). Yard still checks
for new versions, but only says "Yard 0.15.0 is available" with an Update
now button; nothing installs until you press it. Updates carry security
fixes, and a version that is too old may stop connecting, so keep this on
unless you have a reason.
When something goes wrong
Every problem has an error code, a one-press fix when there is one, and a guide:
| Code | Problem |
|---|---|
| YRD-DOCKER-001 | No container engine is installed |
| YRD-DOCKER-002 | The container engine is not running |
| YRD-DOCKER-003 | This account may not use Docker |
| YRD-WSL-001 | WSL needs installing or updating |
| YRD-VIRT-001 | Virtualization is turned off |
| YRD-DISK-001 | Not enough free disk space |
| YRD-ONLINE-001 | This computer cannot reach Yard |
| YRD-TOKEN-001 | Yard did not accept this computer |
Help & logs → Copy details for support copies the app's version, this computer's checks and the last log lines, with keys and tokens taken out.