PR #2008 - AgentWorkforce/relay

Draft for a human rewrite of the README. It's kept separate from code PRs on purpose.

The commit here is only two factual corrections:

relaycast-engine is published for every platform since engine 11.1.0, so "when published for your platform" is removed.
The npm paragraph: npm installs both agent-relay and relay, and since #2006 relay init downloads relaycast-engine into ~/.agentworkforce/relay/bin, not only the broker.

Left for the human edit

relay after install.sh: done. #2009 merged, so install.sh creates relay too, and the table's launcher row now mentions it.
Released version: Getting Started describes 15.0.0 (relay init, single install dir, guided setup), but latest and install.sh install 14.0.0 until 15.0.0 is released. Merge this with or after the 15.0.0 release, or mention @next meanwhile.
Opening of Getting Started: it says "the easiest way is Agent Relay Cloud", while the steps below are local-first with no account needed. Decide which comes first.
Top copy and sections: Messaging, Integrations, Shared Sessions and Flows read as intended? Typos: "teammates agents", "Learn how write a flow", "lets be honest".
Shared Sessions MCP: agent-relay mcp --sessions-only still exists, but check it against the planned CLI command cut.
Badges: they point at @agent-relay/sdk, not the agent-relay CLI.
Quickstart: read docs/quickstart.md alongside, since the README links to it for flags and hosted/self-hosted.

🤖 Generated with Claude Code

^{Need help on this PR? Tag @codesmith-bot with what you need.}

Agent Relay sessions

claude session 5a4f854b · opened via gh pr create · last active 2026-10-28
claude session 8ab900cc · contributor · ran gh pr commands · last active 2026-10-31

Main is merged in, and Getting Started now has the flow verified end to end this week:

relay init sets up the detected tools for message injection. Run it in a project folder, not ~. Find agent names with relay agent list. The old "message codex-<your-folder>" was wrong: names also include the session title.
Working with teammates: relay init --hosted, then each teammate runs relay init --key '<key>'.
Which sessions join: Codex app, VS Code, Conductor, local Claude desktop sessions, Muse and similar join. Cloud Claude sessions, Claude Desktop chat, Cursor Composer, and sessions in ~ or temp folders don't.
Session history: the init core doesn't upload transcripts, and the desktop app follows its own sharing rules.
Undo: --uninstall and --stop.

Still for the human edit:

Release dependency: the plain relay init (no prompts) and relay init --key commands land with relay#2028 in 15.0.0-next.8. Until then, relay init asks three questions and teammates use relay init --url https://cast.agentrelay.com --key … --name …. Merge this with or after a release that has #2028.
Unverified rows: the Codex app, VS Code, Conductor and Claude desktop rows in "Which sessions join" haven't been tested against the relay init core yet.
Agent discovery: relay#2032 installs a messaging skill so agents can find each other without being told. Mention it if that ships.
Consistency: the opening, voice and length are yours. The new sections follow the docs site's Getting started page (agentrelay.com#255).