Skip to content

docs(readme): refresh for 15.0.0 (human edit) #2008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kjgbot merged 5 commits into from
Oct 31, 2026
Merged

docs(readme): refresh for 15.0.0 (human edit) #2008

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8dc68ff
docs(readme): correct the engine and npm install notes
khaliqgant Oct 27, 2026
b582214
docs(readme): note the relay launcher install.sh now creates
khaliqgant Oct 28, 2026
6d6725f
Merge remote-tracking branch 'origin/main' into docs/readme-refresh
Oct 31, 2026
214cff4
docs(readme): CLI-first getting started, teammates, which sessions jo…
Oct 31, 2026
18edfc2
docs(readme): keep Getting started short; desktop app as the upgrade
Oct 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 11 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ curl -fsSL https://raw.githubusercontent.com/AgentWorkforce/relay/main/install.s

The install script puts every Agent Relay binary in one place, `~/.agentworkforce/relay/bin`:

| Binary | What it is |
| -------------------- | ------------------------------------------------------------ |
| `agent-relay` | the CLI (a launcher for it is put in `~/.local/bin`) |
| `agent-relay-broker` | the local broker the CLI starts |
| `relaycast-engine` | the local Relaycast server, when published for your platform |
| Binary | What it is |
| -------------------- | -------------------------------------------------------------------------------------------- |
| `agent-relay` | the CLI (launchers for it, `agent-relay` and the shorter `relay`, are put in `~/.local/bin`) |
| `agent-relay-broker` | the local broker the CLI starts |
| `relaycast-engine` | the local Relaycast server |

The CLI, its broker and the desktop app all use the binaries in that directory. Set `AGENT_RELAY_INSTALL_DIR` (or `AGENT_RELAY_HOME`) to move it; binaries then live in its `bin/`.

Expand All @@ -70,24 +70,21 @@ npm also works:
npm install -g agent-relay
```

npm links the `agent-relay` CLI into its own global bin directory (`$(npm prefix -g)/bin`), not into `~/.agentworkforce/relay/bin`. On its first run, the npm-installed CLI copies only its broker (`agent-relay-broker`) into `~/.agentworkforce/relay/bin`, so the CLI, the desktop app and SDK callers share one broker. It never replaces a newer broker that is already there.
npm links the `agent-relay` and `relay` commands into its own global bin directory (`$(npm prefix -g)/bin`), not into `~/.agentworkforce/relay/bin`. The npm-installed CLI still keeps its broker and the local Relaycast server in `~/.agentworkforce/relay/bin`: it copies its broker there on first run, and `relay init` downloads `relaycast-engine` there, so the CLI, the desktop app and SDK callers share them. It never replaces a newer broker that is already there.

Then, in your project, run:
In a project folder, run:

```bash
relay init
```

It starts a private server on this machine (no account needed), finds the coding agents you have installed (Claude Code, Codex, OpenCode, Grok CLI, Pi, Devin), and adds Relay to them for this project or every project. Open Claude Code and ask it to message `codex-<your-folder>`; each session joins Relay as `<tool>-<folder>` by itself.
Open Claude Code or Codex there. Each session joins Relay by itself; `relay agent list` shows who's on it, and you can ask your agent to "DM `<name>` over Agent Relay".

Scripts and shells without MCP use the CLI directly:
**With teammates:** one person runs `relay init --hosted` and shares the `relay init --key '<key>'` line it prints; each teammate runs that line.
Comment thread
kjgbot marked this conversation as resolved.
Resolved

```bash
relay agent register alice && relay agent register bob
relay message dm send bob "hello" --as alice
```
Undo with `relay init --uninstall`. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md).

@greptile-apps greptile-apps Bot Oct 31, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Undo leaves processes running

relay init --uninstall removes tool settings and turns off message injection, but leaves the local server and core running. Readers following these instructions may think setup has been fully undone. Also mention relay init --stop so they can stop the background processes.

Suggested change
Undo with `relay init --uninstall`. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md).
Undo with `relay init --uninstall`, then run `relay init --stop` to stop the local server and core. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md).
Prompt To Fix With AI 
This is a comment left during a code review.
Path: README.md
Line: 85

Comment:
**Undo leaves processes running**

`relay init --uninstall` removes tool settings and turns off message injection, but leaves the local server and core running. Readers following these instructions may think setup has been fully undone. Also mention `relay init --stop` so they can stop the background processes.

```suggestion
Undo with `relay init --uninstall`, then run `relay init --stop` to stop the local server and core. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md).
```

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Fix in Codex Fix in Claude Code


The [quickstart](docs/quickstart.md) covers the guided setup, its flags (`--tools`, `--scope`, `--yes`, `--uninstall`), moving to the hosted service when agents on other machines need to join, and running your own server.
**Upgrade:** the [Agent Relay desktop app](https://agentrelay.com/docs/quickstart) shares sessions with your team and puts more of your agents on the relay.

### Self Hosting

Expand Down
Loading