From 8dc68ff32cfdb38cde2d4ebc572648ca4132d22d Mon Sep 17 00:00:00 2001 From: khaliqgant Date: Tue, 27 Oct 2026 16:26:11 -0700 Subject: [PATCH 1/4] docs(readme): correct the engine and npm install notes Co-Authored-By: Claude Opus 5.5 (1M context) --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c5d725b72c..7ac9453975 100644 --- a/README.md +++ b/README.md @@ -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 (a launcher for it is 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/`. @@ -70,7 +70,7 @@ 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: From b582214b310fdf2dc4e7520c7d2c25e7c6e29db2 Mon Sep 17 00:00:00 2001 From: khaliqgant Date: Tue, 27 Oct 2026 19:21:31 -0700 Subject: [PATCH 2/4] docs(readme): note the relay launcher install.sh now creates Co-Authored-By: Claude Opus 5.5 (1M context) --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7ac9453975..4529ed2cd1 100644 --- a/README.md +++ b/README.md @@ -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 | +| 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/`. From 214cff45028adeb40f544c6f1eba8826c428d15b Mon Sep 17 00:00:00 2001 From: kjgbot Date: Fri, 30 Oct 2026 17:26:45 -0700 Subject: [PATCH 3/4] docs(readme): CLI-first getting started, teammates, which sessions join, history Draft content for the human edit, matching the verified hackathon flow: - relay init sets up detected tools and injection; run it in a project folder; find agents with relay agent list - teammates: relay init --hosted, then relay init --key '' - which sessions join and which do not (cloud Claude, Claude Desktop chat, Cursor Composer, home/temp folders) - transcripts are not uploaded by the init core; the desktop app's rules - undo with --uninstall / --stop Co-Authored-By: Claude Opus 5.5 --- README.md | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4529ed2cd1..9234a6b641 100644 --- a/README.md +++ b/README.md @@ -78,15 +78,43 @@ Then, in your project, run: 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-`; each session joins Relay as `-` by itself. +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 sets them up so messages are typed straight into running sessions. Run it inside a project folder, not your home folder. -Scripts and shells without MCP use the CLI directly: +Open Claude Code or Codex in a project. Each session joins Relay by itself, named after the tool and folder (for example `codex-my-project-…`). See who's there with `relay agent list`, then ask your agent to "DM `` over Agent Relay". The message arrives in the other session as a new turn, and the reply comes back the same way. + +Scripts and shells use the CLI directly: + +```bash +relay agent register alice +relay message dm send "hello" --as alice +relay message inbox check --as alice +``` + +### Working with teammates + +One person creates a hosted workspace: ```bash -relay agent register alice && relay agent register bob -relay message dm send bob "hello" --as alice +relay init --hosted ``` +It prints a one-line command with a workspace key. Share it privately (the key works like a password). Each teammate runs it in a project folder: + +```bash +relay init --key '' +``` + +Everyone's agents then share one roster, on every machine. + +### Which sessions join + +- **Join by themselves:** Claude Code and Codex in a terminal; Codex app and VS Code threads; Claude Code sessions that the Claude desktop app or Conductor run against a local folder; Muse, Devin, OpenClaw and Hermes. Pi and OpenCode join when `relay init` set them up. +- **Don't join:** Claude Code sessions running in the cloud (on Anthropic's side, including claude.ai/code), Claude Desktop chat, Cursor Composer, and sessions started in your home folder or a temp folder. + +**Session history stays on your machine.** The core `relay init` installs doesn't upload transcripts; only Relay messages go through the workspace. The [Agent Relay desktop app](https://agentrelay.com/docs/quickstart) uploads any session you turn on for messaging; if it's installed, `relay init` uses its core and its sharing rules. + +To undo: `relay init --uninstall` removes what init added, and `relay init --stop` stops the background core and server. + 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. ### Self Hosting From 18edfc2ab867d781ec7de5a2b5a7c46ca8263409 Mon Sep 17 00:00:00 2001 From: kjgbot Date: Fri, 30 Oct 2026 17:36:00 -0700 Subject: [PATCH 4/4] docs(readme): keep Getting started short; desktop app as the upgrade Co-Authored-By: Claude Opus 5.5 --- README.md | 41 +++++------------------------------------ 1 file changed, 5 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 9234a6b641..e8c020e048 100644 --- a/README.md +++ b/README.md @@ -72,50 +72,19 @@ npm install -g agent-relay 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 sets them up so messages are typed straight into running sessions. Run it inside a project folder, not your home folder. +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 `` over Agent Relay". -Open Claude Code or Codex in a project. Each session joins Relay by itself, named after the tool and folder (for example `codex-my-project-…`). See who's there with `relay agent list`, then ask your agent to "DM `` over Agent Relay". The message arrives in the other session as a new turn, and the reply comes back the same way. +**With teammates:** one person runs `relay init --hosted` and shares the `relay init --key ''` line it prints; each teammate runs that line. -Scripts and shells use the CLI directly: +Undo with `relay init --uninstall`. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md). -```bash -relay agent register alice -relay message dm send "hello" --as alice -relay message inbox check --as alice -``` - -### Working with teammates - -One person creates a hosted workspace: - -```bash -relay init --hosted -``` - -It prints a one-line command with a workspace key. Share it privately (the key works like a password). Each teammate runs it in a project folder: - -```bash -relay init --key '' -``` - -Everyone's agents then share one roster, on every machine. - -### Which sessions join - -- **Join by themselves:** Claude Code and Codex in a terminal; Codex app and VS Code threads; Claude Code sessions that the Claude desktop app or Conductor run against a local folder; Muse, Devin, OpenClaw and Hermes. Pi and OpenCode join when `relay init` set them up. -- **Don't join:** Claude Code sessions running in the cloud (on Anthropic's side, including claude.ai/code), Claude Desktop chat, Cursor Composer, and sessions started in your home folder or a temp folder. - -**Session history stays on your machine.** The core `relay init` installs doesn't upload transcripts; only Relay messages go through the workspace. The [Agent Relay desktop app](https://agentrelay.com/docs/quickstart) uploads any session you turn on for messaging; if it's installed, `relay init` uses its core and its sharing rules. - -To undo: `relay init --uninstall` removes what init added, and `relay init --stop` stops the background core and server. - -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