ai/byre
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 11 Wiki Activity

Prune docs to what code can't say

Browse Source
This commit is contained in:
Ian Gulliver
2026-10-20 22:25:27 -07:00
parent 2bfa62449d
commit 9c07c83d7e
8 changed files with 118 additions and 651 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -2
View File
@@ -28,11 +28,11 @@ macOS, a [Tailscale](https://tailscale.com) tailnet with MagicDNS and HTTPS cert
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.
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.
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.
## Docs
- [docs/operations.md](docs/operations.md): layout, data, service, APIs and how every feature works.
- [docs/operations.md](docs/operations.md): external setup, vendor and platform quirks, and the intent behind byre's rules.
- [docs/macos.md](docs/macos.md): the macOS app.
- [AGENTS.md](AGENTS.md): rules for agents working on byre.