Files
byre/README.md
T

42 lines
4.1 KiB
Markdown

# 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.
## 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.
- **Cross-vendor reviews.** Every turn that changes files is snapshotted and reviewed by the other vendor's model. Findings go back to the agent, and you can fix or ignore each one.
- **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 over HTTPS through `tailscale serve`.
- **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
macOS, [Tailscale](https://tailscale.com) on every Mac, and on the Mac that runs the server, `git`, the `claude` and `codex` CLIs (and for Gemini models the Antigravity CLI, `brew install --cask antigravity-cli`, signed in once by running `agy`), Node.js (agents' Playwright browser tools run through `npx`) and Google Chrome (`brew install git node --cask google-chrome`). Identity comes from Tailscale: byre only serves requests that arrive through `tailscale serve`.
## Installing
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.
2. On the Mac that runs the server, open byre and click **Run byre on this Mac**. It first checks for `git`, Tailscale (signed in, with HTTPS certificates turned on) 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`, serves it through `tailscale serve`, 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.
3. Open byre on each other Mac; it picks up the server's URL through iCloud, or enter that URL.
The app updates itself, and the server along with it on the server's Mac. To build from source instead, see "Running as a service" and "macOS app" in [docs/operations.md](docs/operations.md); that needs Go and Xcode.
## Docs
- [docs/operations.md](docs/operations.md): layout, data, service, APIs and how every feature works.
- [docs/macos.md](docs/macos.md): the macOS app.
- [AGENTS.md](AGENTS.md): rules for agents working on byre.
## License
[Apache 2.0](LICENSE)