Files
byre/README.md
T

44 lines
4.5 KiB
Markdown
Raw Normal View History

2026-10-18 11:49:18 -07:00
# byre
A server and macOS app for running many coding agents (Claude Code, Codex and Antigravity) in parallel on your own Mac, each on its own branch, with a lead agent that keeps track of them for you.
2026-10-18 11:49:18 -07:00
## Features
- **Tasks.** Each task gets its own git worktree, branch and port block. Talk to its agent in a live transcript; messages sent mid-turn reach it after its next tool call.
- **Lead agent.** One long-running agent per user watches every task, tells you what needs you, points the right pane at it, and starts, messages, merges or discards tasks when you ask. It keeps notes on how you work and passes them to task agents.
- **Questions.** Agents ask structured questions with a recommended answer; you answer by clicking. Each question shows in the transcript where it was asked, and clicking it shows it again with your answer. macOS notifications for questions, turn summaries and errors.
2026-10-20 22:35:22 -07:00
- **Reviews.** Choose a review workflow for each project. Its reviewers check the task's work after each turn that changes files. Findings go back to the agent, and you can fix or ignore each one.
2026-10-18 11:49:18 -07:00
- **Snapshots and forks.** Step through a task's snapshots, diff any of them, and fork a new task from any one, conversation included.
- **Merge.** One click: the agent merges main in and resolves conflicts, then byre squashes, pushes and closes the task, with co-author trailers and a git note recording the task. Merge after review, and one merge per project at a time with a queue.
- **Subtasks and teams.** Agents can spawn subtasks on their own branches and merge them back, or several agents can share one worktree and talk through a board.
- **Workflows.** Named graphs of stages, each run as its own task, with fan-out and fan-in.
- **TODO.md.** A project's `TODO.md` items show on its dashboard; start or discuss one in a click.
- **Changes, Files and Terminal.** Per-task diff view with line comments sent to the agent, a read-only file browser, and a shell in the worktree.
- **Previews.** Agents expose dev servers, and the app opens each at a local `*.localhost` address forwarded over the tailnet.
2026-10-18 11:49:18 -07:00
- **Screen and app control.** Agents can see and drive the Mac byre runs on (screen capture, accessibility, Orion, Chrome DevTools) and the Macs you have the app open on (shell, files, the same screen tools).
- **Status.** Running turns, stuck or zombie agent processes, rate-limit usage and connected clients.
## Requirements
2026-10-20 22:49:58 -07:00
macOS and a [Tailscale](https://tailscale.com) tailnet with MagicDNS and HTTPS certificates turned on. byre and the app each join it as their own node, so no Mac needs the Tailscale app. Identity comes from Tailscale: byre serves only the tailnet's users, as its node identifies them.
The Mac that runs the server needs `git` and at least one agent CLI: Claude Code (`claude`), Codex (`codex`) or Antigravity (`agy`, for Gemini models; `brew install --cask antigravity-cli`, signed in once by running `agy`). Browser tools also need Node.js (agents' Playwright tools run through `npx`) and Google Chrome (`brew install git node --cask google-chrome`).
2026-10-18 11:49:18 -07:00
## Installing
2026-10-18 11:49:18 -07:00
1. Download [byre](https://dl.byre.run/byre.dmg) from [byre.run](https://byre.run) and drag `Byre.app` to Applications, on every Mac you'll use byre from. Open it and click **Sign in to Tailscale** to put that Mac's byre on your tailnet; byre servers on your tailnet show up on their own.
2. On the Mac that runs the server, click **Run byre on this Mac**. It first checks for `git` and at least one of `claude`, `codex` and `agy`, and lists anything missing with how to install it. Then it installs the server as a launchd service, using your login shell's `PATH` to find `claude`, `codex`, `agy`, `git` and `npx`, asks you to sign the server's own Tailscale node in, and connects to it. The Server tab shows its URL, turns it off and on, and lists the tools it found and how to install the missing ones.
2026-10-18 16:14:03 -07:00
3. Open byre on each other Mac; it picks up the server's URL through iCloud, or enter that URL.
2026-10-20 22:25:27 -07:00
The app updates itself, and the server along with it on the server's Mac. To build from source instead, run `mac/bundle.sh` (see "Stack" and "Signing" in [docs/macos.md](docs/macos.md)), then `byre install` from the built app (see "Running as a service" in [docs/operations.md](docs/operations.md)); that needs Go and Xcode.
2026-10-18 11:49:18 -07:00
## Docs
2026-10-20 22:25:27 -07:00
- [docs/operations.md](docs/operations.md): external setup, vendor and platform quirks, and the intent behind byre's rules.
2026-10-18 11:49:18 -07:00
- [docs/macos.md](docs/macos.md): the macOS app.
- [AGENTS.md](AGENTS.md): rules for agents working on byre.
## License
[Apache 2.0](LICENSE)