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

Align documentation and user-facing terminology

Browse Source
This commit is contained in:
Ian Gulliver
2026-10-21 11:58:15 -07:00
parent 66affd7622
commit 069474e6aa
3 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -11,7 +11,7 @@ A server and macOS app for running many coding agents (Claude Code, Codex and An
- **Snapshots and forks.** Step through a task's snapshots and diff any of them. Claude Code and Codex snapshots can also start a new task with the conversation included; Antigravity cannot fork conversations. - **Snapshots and forks.** Step through a task's snapshots and diff any of them. Claude Code and Codex snapshots can also start a new task with the conversation included; Antigravity cannot fork conversations.
- **Merge.** One click: the agent merges the default branch 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. - **Merge.** One click: the agent merges the default branch 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. - **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. - **Workflows.** Named sequences of steps that run in order or in parallel, with each stage running as its own task.
- **TODO.md.** A project's `TODO.md` items show in the Project tab; start or discuss one in a click. - **TODO.md.** A project's `TODO.md` items show in the Project tab; 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 shells in the worktree, including ones that start by running a saved command. - **Changes, Files and Terminal.** Per-task diff view with line comments sent to the agent, a read-only file browser, and shells in the worktree, including ones that start by running a saved command.
- **Previews.** Agents expose dev servers, and the app opens each at a local `*.localhost` address forwarded over the tailnet. - **Previews.** Agents expose dev servers, and the app opens each at a local `*.localhost` address forwarded over the tailnet.
docs/macos.md
+1 -1
View File
@@ -39,7 +39,7 @@ Every build is signed for distribution outside the App Store: the team's Develop
## Updates ## Updates
The app runs Sparkle with its own user driver instead of Sparkle's standard windows, so no update UI offers Skip or turning automatic updates off, which `byre-update` would override. A Mac that runs the server but not the app is updated by `byre-update`, which the server runs daily; it does nothing while the app is running from that bundle, leaving the update to the app's own updater. The update UI must not offer Skip or turning automatic updates off: on a Mac running the server, `byre-update` would override either choice while the app isn't running.
## Persistence ## Persistence
docs/operations.md
-1
View File
@@ -126,4 +126,3 @@ byre never signs with a key on the machine it runs on. When a project checkout's
- Saved commands belong to a user on one server, because what they do is usually tied to that Mac: signing in again to the credential an `apiKeyHelper` uses (AppleConnect's `getToken -n cli` on a work Mac) is the case they were made for. Its terminal stays open after the command, so the result stays readable. - Saved commands belong to a user on one server, because what they do is usually tied to that Mac: signing in again to the credential an `apiKeyHelper` uses (AppleConnect's `getToken -n cli` on a work Mac) is the case they were made for. Its terminal stays open after the command, so the result stays readable.
- It types one byte per write: a program in raw mode that stops reading blocks a PTY write, and the PTY's file doesn't support deadlines, so this keeps the call within its limits while leaving at most one byte to arrive late. - It types one byte per write: a program in raw mode that stops reading blocks a PTY write, and the PTY's file doesn't support deadlines, so this keeps the call within its limits while leaving at most one byte to arrive late.
- zsh gets shell integration through a `.zshenv` in `<data>/zsh` (via `ZDOTDIR`) that reports the prompt (OSC 133) and the line being edited, so byre can wake the agent when a line it left is run. It turns off `PROMPT_SP`, which would print a `%` padded to the width the shell started at, so an agent-opened shell (120 columns) replayed in a narrower tab wraps each one onto an extra line. A user `.zshrc` that sets `zle-line-pre-redraw` with `zle -N` rather than `add-zle-hook-widget` replaces the hook, and byre then sees the line as empty. Other shells get no integration and nothing wakes their agents. - zsh gets shell integration through a `.zshenv` in `<data>/zsh` (via `ZDOTDIR`) that reports the prompt (OSC 133) and the line being edited, so byre can wake the agent when a line it left is run. It turns off `PROMPT_SP`, which would print a `%` padded to the width the shell started at, so an agent-opened shell (120 columns) replayed in a narrower tab wraps each one onto an extra line. A user `.zshrc` that sets `zle-line-pre-redraw` with `zle -N` rather than `add-zle-hook-widget` replaces the hook, and byre then sees the line as empty. Other shells get no integration and nothing wakes their agents.
- The terminal WebSocket checks that `Origin` matches `Host`, so another site can't open one through the user's Tailscale identity.