Skip to content

fix: point agents to the Community first and lead the README with the world #394

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
oddessentials merged 2 commits into from
Nov 13, 2026
Merged

fix: point agents to the Community first and lead the README with the world #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4320b9
Lead the README with the world, the stores and three ways in
oddessentials Nov 13, 2026
ea6387f
Point agents to the Community first for ready-made Yards, characters …
oddessentials Nov 13, 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
85 changes: 48 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
<h1 align="center">Agent Guild</h1>

<p align="center">
<img src="https://img.shields.io/badge/Windows%20%7C%20macOS%20%7C%20Linux-free-e8c47c" alt="Free on Windows, macOS and Linux">
<a href="https://www.npmjs.com/package/@oddessentials/agent-guild"><img src="https://img.shields.io/npm/v/@oddessentials/agent-guild?color=7c5cff&label=npm" alt="npm version"></a>
<a href="https://github.com/oddessentials/agent-guild/actions/workflows/release.yml"><img src="https://img.shields.io/github/actions/workflow/status/oddessentials/agent-guild/release.yml?branch=main&label=release" alt="Release status"></a>
<img src="https://img.shields.io/badge/platforms-Windows%20%7C%20macOS%20%7C%20Linux-e8c47c" alt="Windows, macOS and Linux">
<img src="https://img.shields.io/node/v/@oddessentials/agent-guild?color=4cc38a" alt="Node.js version">
<a href="https://marketplace.visualstudio.com/items?itemName=OddEssentials.agent-guild"><img src="https://img.shields.io/badge/VS%20Code-Marketplace-007acc" alt="Agent Guild for VS Code"></a>
<a href="https://apps.apple.com/us/app/agent-guild-remote/id6825451331"><img src="https://img.shields.io/badge/App%20Store-iPhone%20%7C%20iPad%20%7C%20Vision%20Pro-0d96f6?logo=apple&logoColor=white" alt="Agent Guild on the App Store"></a>
<a href="https://play.google.com/store/apps/details?id=com.oddessentials.agentguild"><img src="https://img.shields.io/badge/Google%20Play-Android%20%7C%20TV%20%7C%20XR-34a853?logo=googleplay&logoColor=white" alt="Agent Guild on Google Play"></a>
<a href="https://www.amazon.com/dp/B0HPLBDYPR"><img src="https://img.shields.io/badge/Amazon%20Appstore-Fire%20tablets%20%7C%20Fire%20TV-ff9900" alt="Agent Guild on the Amazon Appstore"></a>
<a href="https://www.meta.com/experiences/1325496170657270/"><img src="https://img.shields.io/badge/Meta%20Horizon-Quest-0467df?logo=meta&logoColor=white" alt="Agent Guild on the Meta Horizon Store"></a>
<a href="https://store.steampowered.com/app/5462970/Agent_Guild_World/"><img src="https://img.shields.io/badge/Steam-Agent%20Guild%3A%20World-1b2838?logo=steam&logoColor=white" alt="Agent Guild: World on Steam"></a>
</p>

<p align="center"><strong>English</strong> · <a href="README.zh-CN.md">简体中文</a> · <a href="README.zh-TW.md">繁體中文</a></p>

**Run Claude Code, Codex CLI, Antigravity CLI, Grok Build, Docker Agent and
your own shells side by side in real terminals. Pick the same live sessions up
from your phone, VS Code or any browser. Free, on Windows, macOS and Linux.**
**Your agents, your world, in any style you can imagine.**

Agent Guild is a small manager that runs on your computer and serves one
local web page. Close the page whenever you like; the sessions keep running.
Run Claude Code, Codex CLI, Antigravity CLI, Grok Build, Docker Agent and your
own shells side by side in real terminals, and watch every session at work as
a character in a living 3D world: double-click one to open its real terminal.
Pick the same live sessions up from your phone, VS Code or any browser. Free,
on Windows, macOS and Linux.

Agent Guild runs on your computer and serves one local web page. Close the
page whenever you like; the sessions keep running.

<a href="https://oddessentials.github.io/agent-guild/?view=yard&skin=guild&theme=dark"><picture>
<source media="(prefers-reduced-motion: reduce)" srcset="docs/images/yard-still.webp">
Expand All @@ -26,6 +34,8 @@ walk the Yard in your browser. Simulated, free, no account and nothing installed

## Quick start

**Download the installer.** It brings its own Node.js.

<p align="center">
<a href="https://github.com/oddessentials/agent-guild/releases/latest/download/agent-guild-windows-setup.exe"><picture><source media="(prefers-color-scheme: light)" srcset="docs/images/download-windows-light.webp"><img src="docs/images/download-windows-dark.webp" alt="Download Agent Guild for Windows" width="180"></picture></a>
<a href="https://github.com/oddessentials/agent-guild/releases/latest/download/agent-guild-macos-arm64.pkg"><picture><source media="(prefers-color-scheme: light)" srcset="docs/images/download-macos-light.webp"><img src="docs/images/download-macos-dark.webp" alt="Download Agent Guild for macOS" width="180"></picture></a>
Expand All @@ -35,23 +45,28 @@ walk the Yard in your browser. Simulated, free, no account and nothing installed

<p align="center"><sub>On Linux, extract the download and run <code>./install.sh</code>. · <a href="https://github.com/oddessentials/agent-guild/releases/latest/download/agent-guild-macos-x64.pkg">macOS on Intel</a> · <a href="https://github.com/oddessentials/agent-guild/releases/latest">All downloads and checksums</a></sub></p>

Or install with npm, on Node.js 22 or newer:
**Or install it with npm**, on Node.js 22 or newer:

```sh
npm install -g @oddessentials/agent-guild
agent-guild
```

**Or ask your agent.** Paste this into Claude Code, Codex CLI or any coding agent:

```text
Set up Agent Guild for me: https://agentguild.oddessentials.ai/agents/
```

It installs and checks Agent Guild, then connects to it over [MCP](docs/mcp.md)
to see and steer your sessions. In Claude Code you can also add it as a plugin:
`claude plugin marketplace add oddessentials/agent-guild --sparse .claude-plugin plugins`,
then `claude plugin install agent-guild@agent-guild`.

The page opens in your browser. Press **New** on a tool's card to start a
session. Sign in to each tool inside its first session, as you would in any
terminal. To look around first, [try the demo](https://oddessentials.github.io/agent-guild/?view=yard&skin=guild&theme=dark)
(simulated, nothing installed) or [watch the trailer](https://www.youtube.com/watch?v=_vQuW0v-uMY).

**Or ask your agent.** Point it at
[the setup skill](https://github.com/oddessentials/agent-guild/blob/main/plugins/agent-guild/skills/setup-agent-guild/SKILL.md),
or run `claude plugin marketplace add oddessentials/agent-guild --sparse .claude-plugin plugins`
and `claude plugin install agent-guild@agent-guild`. It installs and checks Agent Guild,
then connects over [MCP](docs/mcp.md) to see and steer your sessions.
terminal. [Watch the trailer](https://www.youtube.com/watch?v=_vQuW0v-uMY) to
see it all at work.

## Why Agent Guild

Expand All @@ -69,15 +84,10 @@ then connects over [MCP](docs/mcp.md) to see and steer your sessions.
Codex CLI.
* **The same session on every screen.** Any browser, a phone over
[Tailscale](#remote-access-with-tailscale) with touch keys, VS Code, and
the Agent Guild app: iPhone, iPad and Apple Vision Pro on the
[App Store](https://apps.apple.com/us/app/agent-guild-remote/id6825451331);
Android, Android TV, Google TV and Android XR on
[Google Play](https://play.google.com/store/apps/details?id=com.oddessentials.agentguild)
or [GitHub](https://github.com/oddessentials/agent-guild-android/releases/latest);
Fire tablets and Fire TV on the [Amazon Appstore](https://www.amazon.com/dp/B0HPLBDYPR);
and Meta Quest on the [Meta Horizon Store](https://www.meta.com/experiences/1325496170657270/).
Apple Watch and Meta Ray-Ban Display list your sessions and read a
session's last answer aloud. See [what each screen needs](https://agentguild.oddessentials.ai/requirements/).
the Agent Guild app on phones, tablets, TVs and headsets, from the stores
above or [GitHub](https://github.com/oddessentials/agent-guild-android/releases/latest)
for Android. Apple Watch and Meta Ray-Ban Display list your sessions and
read a session's last answer aloud. See [what each screen needs](https://agentguild.oddessentials.ai/requirements/).
* **Native on Windows.** No WSL. Also macOS, Linux, and headless Linux
servers over SSH.
* **Nothing in between.** No account and no relay server: the manager
Expand Down Expand Up @@ -243,13 +253,6 @@ The first Claude Code usage meter may ask for access to the

<img src="docs/images/workspace.webp" alt="Two terminals side by side with the GitHub panel showing the workflow runs of the focused terminal's repository">

### The Yard

For fun, the Yard shows your tools and sessions as a 3D world, one for each
skin. A double-click on a character opens its real terminal. The clip at the
top of this page shows it, and [the demo](https://oddessentials.github.io/agent-guild/?view=yard)
lets you try every skin.

<table>
<tr>
<td width="33%" align="center"><a href="docs/images/terminal.webp"><img src="docs/images/terminal-thumb.webp" alt="A Claude Code session's terminal, with its helper agents in the header"></a><br><sub>Terminal</sub></td>
Expand All @@ -263,6 +266,16 @@ lets you try every skin.
</tr>
</table>

### The Yard

Every session is a character in a living 3D world, one world for each skin.
Swap in a Yard or theme from the [community](https://github.com/oddessentials/agent-guild-community),
or make your own with [Agent Guild: Builders](https://github.com/oddessentials/agent-guild-builders)
and [Agent Guild: Studio](https://github.com/oddessentials/agent-guild-studio). A
double-click on a character opens its real terminal. The clip at the top of
this page shows it, and [the demo](https://oddessentials.github.io/agent-guild/?view=yard)
lets you try every skin.

## Commands

| Command | What it does |
Expand All @@ -281,10 +294,8 @@ lets you try every skin.
Sessions end when the manager stops or the computer restarts. tmux and herdr
sessions survive a manager stop.

After upgrading Agent Guild and restarting the manager, refresh every open
Agent Guild browser page to load the new frontend. Pages reconnect
automatically, but keep their loaded JavaScript until refreshed. Refreshing
is required for compatibility with the upgraded manager.
After an upgrade, refresh every open Agent Guild page: pages reconnect on
their own but keep running the old page until refreshed.

## Privacy

Expand Down
47 changes: 34 additions & 13 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
<h1 align="center">Agent Guild</h1>

<p align="center">
<img src="https://img.shields.io/badge/Windows%20%7C%20macOS%20%7C%20Linux-free-e8c47c" alt="Free on Windows, macOS and Linux">
<a href="https://www.npmjs.com/package/@oddessentials/agent-guild"><img src="https://img.shields.io/npm/v/@oddessentials/agent-guild?color=7c5cff&label=npm" alt="npm version"></a>
<a href="https://marketplace.visualstudio.com/items?itemName=OddEssentials.agent-guild"><img src="https://img.shields.io/badge/VS%20Code-Marketplace-007acc" alt="Agent Guild for VS Code"></a>
<a href="https://apps.apple.com/us/app/agent-guild-remote/id6825451331"><img src="https://img.shields.io/badge/App%20Store-iPhone%20%7C%20iPad%20%7C%20Vision%20Pro-0d96f6?logo=apple&logoColor=white" alt="Agent Guild on the App Store"></a>
<a href="https://play.google.com/store/apps/details?id=com.oddessentials.agentguild"><img src="https://img.shields.io/badge/Google%20Play-Android%20%7C%20TV%20%7C%20XR-34a853?logo=googleplay&logoColor=white" alt="Agent Guild on Google Play"></a>
<a href="https://www.amazon.com/dp/B0HPLBDYPR"><img src="https://img.shields.io/badge/Amazon%20Appstore-Fire%20tablets%20%7C%20Fire%20TV-ff9900" alt="Agent Guild on the Amazon Appstore"></a>
<a href="https://www.meta.com/experiences/1325496170657270/"><img src="https://img.shields.io/badge/Meta%20Horizon-Quest-0467df?logo=meta&logoColor=white" alt="Agent Guild on the Meta Horizon Store"></a>
<a href="https://store.steampowered.com/app/5462970/Agent_Guild_World/"><img src="https://img.shields.io/badge/Steam-Agent%20Guild%3A%20World-1b2838?logo=steam&logoColor=white" alt="Agent Guild: World on Steam"></a>
</p>

<p align="center"><a href="README.md">English</a> · <strong>简体中文</strong> · <a href="README.zh-TW.md">繁體中文</a></p>

**在你自己的电脑上，用真正的终端并排运行 Claude Code、Codex CLI、Antigravity CLI、
Grok Build、Docker Agent 和你自己的 shell。在手机、VS Code 或任何浏览器上接着用同一批
正在运行的会话。免费，支持 Windows、macOS 和 Linux。**
**你的智能体，你的世界，任何你能想象的风格。**

在真正的终端里并排运行 Claude Code、Codex CLI、Antigravity CLI、Grok Build、Docker Agent
和你自己的 shell，看着每个会话化身为生动 3D 世界里的角色干活：双击一个，就能打开它的真实终端。
在手机、VS Code 或任何浏览器上接着用同一批正在运行的会话。免费，支持 Windows、macOS 和 Linux。

Agent Guild 是一个运行在你电脑上的小管理器，提供一个本地网页。网页随时可以关掉，会话照常运行。

Expand All @@ -18,6 +31,8 @@ Agent Guild 是一个运行在你电脑上的小管理器，提供一个本地

## 快速开始

**下载安装程序。** 自带 Node.js。

<p align="center">
<a href="https://github.com/oddessentials/agent-guild/releases/latest/download/agent-guild-windows-setup.exe"><picture><source media="(prefers-color-scheme: light)" srcset="docs/images/download-windows-light.webp"><img src="docs/images/download-windows-dark.webp" alt="下载 Agent Guild Windows 版" width="180"></picture></a>
<a href="https://github.com/oddessentials/agent-guild/releases/latest/download/agent-guild-macos-arm64.pkg"><picture><source media="(prefers-color-scheme: light)" srcset="docs/images/download-macos-light.webp"><img src="docs/images/download-macos-dark.webp" alt="下载 Agent Guild macOS 版" width="180"></picture></a>
Expand All @@ -27,19 +42,26 @@ Agent Guild 是一个运行在你电脑上的小管理器，提供一个本地

<p align="center"><sub>Linux 上解压后运行 <code>./install.sh</code>。 · <a href="https://github.com/oddessentials/agent-guild/releases/latest/download/agent-guild-macos-x64.pkg">Intel 芯片的 Mac</a> · <a href="https://github.com/oddessentials/agent-guild/releases/latest">全部下载与校验和</a></sub></p>

或者用 npm 安装，需要 Node.js 22 或更新版本：
**或者用 npm 安装**，需要 Node.js 22 或更新版本：

```sh
npm install -g @oddessentials/agent-guild
agent-guild
```

网页会自动在浏览器中打开。在某个工具的卡片上按 **New** 即可启动会话。
每个工具在第一个会话里照常登录，和在任何终端里一样。
**或者交给你的智能体。** 把这句话粘贴给 Claude Code、Codex CLI 或任何编程智能体：

```text
Set up Agent Guild for me: https://agentguild.oddessentials.ai/agents/
```

**或者交给你的智能体。** 让它读取
[安装技能](https://github.com/oddessentials/agent-guild/blob/main/plugins/agent-guild/skills/setup-agent-guild/SKILL.md)，
它会安装并检查 Agent Guild，然后通过 [MCP](docs/mcp.md) 连接，查看并操控你的会话。
在 Claude Code 里也可以作为插件添加：
`claude plugin marketplace add oddessentials/agent-guild --sparse .claude-plugin plugins`，
然后运行 `claude plugin install agent-guild@agent-guild`。

网页会自动在浏览器中打开。在某个工具的卡片上按 **New** 即可启动会话。
每个工具在第一个会话里照常登录，和在任何终端里一样。[观看预告片](https://www.youtube.com/watch?v=_vQuW0v-uMY)，看看它实际运行的样子。

## 为什么选 Agent Guild

Expand All @@ -48,11 +70,10 @@ agent-guild
* **所有智能体，一处管理。** Claude Code、Codex CLI、Antigravity CLI、Grok Build、
Docker Agent、任意 shell，以及 tmux 或 herdr 会话。Claude Code、Codex CLI 和
Grok Build 可以同时登录多个账号；Claude Code 和 Codex 账号的用量上限实时可见。
* **同一个会话，每块屏幕。** 任何浏览器；通过 Tailscale 在手机上使用，带触屏按键；
VS Code；以及 Agent Guild 应用：iPhone、iPad 和 Apple Vision Pro（[App Store](https://apps.apple.com/us/app/agent-guild-remote/id6825451331)），
Android、Android TV、Google TV 和 Android XR（[Google Play](https://play.google.com/store/apps/details?id=com.oddessentials.agentguild)），Fire 平板和 Fire TV
（[Amazon Appstore](https://www.amazon.com/dp/B0HPLBDYPR)），[Meta Horizon Store](https://www.meta.com/experiences/1325496170657270/)。Apple Watch 和 Meta Ray-Ban Display
会列出你的会话，并朗读某个会话的最后一条回答。
* **同一个会话，每块屏幕。** 任何浏览器；通过 Tailscale 在手机上使用，带触屏按键；VS Code；
以及上方各应用商店里适用于手机、平板、电视和头显的 Agent Guild 应用，Android 版也可从
[GitHub](https://github.com/oddessentials/agent-guild-android/releases/latest) 获取。
Apple Watch 和 Meta Ray-Ban Display 会列出你的会话，并朗读某个会话的最后一条回答。
* **Yard：看着它们干活。** 每个会话都是 3D 世界里的一个角色。等你回复的会被标出来；
CI 通过时 Yard 会放烟花。双击任何一个角色，就能打开它的真实终端直接输入。
* **原生支持 Windows。** 无需 WSL。也支持 macOS、Linux，以及通过 SSH 使用的无头 Linux 服务器。
Expand Down
Loading
Loading