claude-relay 2.35.1 → 2.36.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +130 -87
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,87 +2,103 @@
|
|
|
2
2
|
<img src="media/logo/icon-full-banded-256-transparent.png" alt="Clay" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
|
-
<
|
|
5
|
+
<h2 align="center">Use Claude Code and Codex in a browser, with your whole team.</h2>
|
|
6
|
+
<h4 align="center">Self-hosted on your machine. One toggle between vendors. No lock-in.</h4>
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
<p align="center">
|
|
9
|
+
<a href="https://www.npmjs.com/package/clay-server"><img src="https://img.shields.io/npm/v/clay-server" alt="npm version" /></a>
|
|
10
|
+
<a href="https://www.npmjs.com/package/clay-server"><img src="https://img.shields.io/npm/dw/clay-server" alt="npm downloads" /></a>
|
|
11
|
+
<a href="https://github.com/chadbyte/clay"><img src="https://img.shields.io/github/stars/chadbyte/clay" alt="GitHub stars" /></a>
|
|
12
|
+
<a href="https://github.com/chadbyte/clay/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" /></a>
|
|
13
|
+
</p>
|
|
8
14
|
|
|
9
15
|
<p align="center"><img src="media/hero.png" alt="Clay workspace" /></p>
|
|
10
16
|
|
|
11
|
-
|
|
17
|
+
Clay is a team workspace for Claude Code and Codex, self-hosted on your machine. Onboard your team to one tool, share sessions live, switch vendors with a toggle. Your code, your Mates, your decisions, all on disk.
|
|
12
18
|
|
|
13
19
|
```bash
|
|
14
20
|
npx clay-server
|
|
15
21
|
# Scan the QR code to connect from any device
|
|
16
22
|
```
|
|
17
23
|
|
|
18
|
-
|
|
24
|
+
## Why Clay
|
|
19
25
|
|
|
20
|
-
|
|
26
|
+
**One workspace, many people.** Your whole team logs into the same workspace, not a personal editor with billing settings bolted on. Multi-user from day one, with OS-level isolation on Linux.
|
|
21
27
|
|
|
22
|
-
|
|
28
|
+
**Many projects at once.** If you bounce between repos all day, keep them all loaded in one place and run agents in parallel across them. Permission requests and completed jobs surface as notifications so nothing goes silent in a tab you forgot to check.
|
|
23
29
|
|
|
24
|
-
|
|
30
|
+
**Self-hosted.** Clay is a daemon on your machine. Your code, your sessions, your AI teammates' memory all live on disk in plain JSONL and Markdown. No proprietary database. No cloud relay. No middleman.
|
|
25
31
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
32
|
+
**Vendor-agnostic.** Run Claude Code and Codex in the same workspace. Toggle vendors per session. When Anthropic raises prices or OpenAI changes terms, your workflow keeps moving. Same Mates, same projects, same memory, different model.
|
|
33
|
+
|
|
34
|
+
**No lock-in.** Plain files you can grep, version, and back up. Standard cron expressions. MCP servers you already use. CLAUDE.md, AGENTS.md, .cursorrules, all loaded automatically across vendors. Walk away whenever you want, your data walks with you.
|
|
35
|
+
|
|
36
|
+
## Built for Teams
|
|
29
37
|
|
|
30
|
-
|
|
38
|
+
Clay is the workspace your team logs into, not a private editor with billing settings bolted on. Provision a server, invite your team, work in one place.
|
|
31
39
|
|
|
32
|
-
**
|
|
40
|
+
- **Multi-user on a single server.** One Clay daemon hosts everyone on your team. No per-seat SaaS, no separate installs. Add users, they log in, they're in.
|
|
41
|
+
- **OS-level isolation on Linux.** Opt in to provision each Clay user as a real Linux account. File ACLs are enforced via `setfacl`. Processes spawn under the right UID/GID. The isolation guarantees come from the OS, not from a promise in our docs.
|
|
42
|
+
- **Each member brings their own login.** Share one org-wide API key, or let each user sign in with their own Claude Code or Codex account. Costs route to whoever ran the model.
|
|
43
|
+
- **Drop into a teammate's session to help.** When someone gets stuck, jump into their project and pair in real time. Shared control, full history, no screen-share theater.
|
|
44
|
+
- **@mention a teammate when you're stuck.** Ping them right inside the session. Their notification center lights up, their phone buzzes. No teammate around? @mention a Mate instead, same gesture, same place.
|
|
45
|
+
- **Non-developers welcome.** PMs, designers, support engineers can log in to ask questions about the codebase, create issues, or read what the team built, without ever opening an editor.
|
|
33
46
|
|
|
34
|
-
|
|
47
|
+
## What it does
|
|
35
48
|
|
|
36
|
-
|
|
49
|
+
### Run Claude Code and Codex in one workspace
|
|
50
|
+
|
|
51
|
+
Open a session, pick a vendor. Switch sessions, pick the other. Clay's adapter layer (YOKE) speaks the Claude Agent SDK and the Codex app-server protocol natively. Cross-vendor instruction loading: Codex reads AGENTS.md, Claude reads CLAUDE.md, Clay merges the rest into the system prompt automatically.
|
|
37
52
|
|
|
38
53
|
<p align="center">
|
|
39
|
-
<img src="media/
|
|
54
|
+
<img src="media/split.gif" alt="split-screen workflow" width="700">
|
|
40
55
|
</p>
|
|
41
56
|
|
|
42
|
-
###
|
|
43
|
-
|
|
44
|
-
**Fully local.** Clay runs as a daemon on your machine. Your code and conversations never leave your machine except to reach the AI provider's API.
|
|
57
|
+
### Every project on one dashboard
|
|
45
58
|
|
|
46
|
-
|
|
59
|
+
All your projects live in the sidebar. Jump between them in one click, see live status across each, run agents in several at once. No more `cd ~/work/foo && tmux attach && ...`. One Clay daemon hosts every repo on your machine and gives you a single pane of glass over all of them.
|
|
47
60
|
|
|
48
|
-
|
|
61
|
+
### Mates: AI teammates with persistent memory
|
|
49
62
|
|
|
50
|
-
|
|
63
|
+
Mates are AI personas with their own CLAUDE.md, knowledge files, and memory that compounds across sessions. They learn your stack, your conventions, your decision history. @mention them mid-session, DM them directly, or drop them into a debate. **They don't flatter you. They push back.**
|
|
51
64
|
|
|
52
|
-
|
|
65
|
+
### Debate: structured multi-Mate decisions
|
|
53
66
|
|
|
54
|
-
|
|
67
|
+
Stuck on REST vs GraphQL? Monorepo or split? Surface the question to a debate. Pick panelists, set the format, let your Mates argue both sides with moderated turns. You walk away with a recorded decision, not a vibe check.
|
|
55
68
|
|
|
56
|
-
|
|
69
|
+
### Parallel worktrees
|
|
57
70
|
|
|
58
|
-
|
|
71
|
+
Detect existing git worktrees, spin up new ones from the sidebar, and run agents in each one independently. No more "wait, I have uncommitted changes." Each worktree is an isolated session with its own history.
|
|
59
72
|
|
|
60
|
-
|
|
73
|
+
### Ralph Loop: autonomous coding while you sleep
|
|
61
74
|
|
|
62
|
-
|
|
75
|
+
Write a `PROMPT.md`, optionally a `JUDGE.md`, hit go. Clay iterates: code, evaluate, retry, until the judge approves or you cap the loop. Run it once, or schedule it on standard Unix cron. Wake up to a finished feature or a clean failure trace.
|
|
63
76
|
|
|
64
|
-
|
|
77
|
+
### Web UI, mobile, push notifications
|
|
65
78
|
|
|
66
|
-
|
|
79
|
+
Installable PWA on iOS and Android. Push notifications for approvals, errors, and completed tasks. Service worker keeps the app responsive offline. When Claude needs approval, your phone buzzes, you tap approve, the agent keeps going.
|
|
67
80
|
|
|
68
|
-
|
|
81
|
+
<p align="center">
|
|
82
|
+
<img src="media/phone.gif" alt="Clay on phone" width="280">
|
|
83
|
+
</p>
|
|
69
84
|
|
|
70
85
|
## Who is Clay for
|
|
71
86
|
|
|
72
|
-
- **
|
|
73
|
-
- **
|
|
74
|
-
- **
|
|
87
|
+
- **Teams that want one shared workspace, not one editor each.** Onboard your whole team to a single tool, share sessions, set permissions per person, keep code on your own infrastructure.
|
|
88
|
+
- **Teams hedging vendor risk.** You want Claude today, Codex tomorrow, and the freedom to flip without rewriting your workflow.
|
|
89
|
+
- **Self-hosting developers who won't put their code in someone else's cloud.** You run the server, you own the data, you pick the model.
|
|
90
|
+
- **Codex users tired of CLI-only workflows.** Clay treats Codex as a first-class citizen, not a Claude afterthought.
|
|
91
|
+
- **Solo developers building an AI team.** Mates, Debate, and Ralph Loop give you reviewers, decision-makers, and an autonomous coding partner. Your team grows when you're ready.
|
|
75
92
|
|
|
76
93
|
## Getting Started
|
|
77
94
|
|
|
78
|
-
**Requirements:** Node.js 20
|
|
95
|
+
**Requirements:** Node.js 20+. Authenticated Claude Code CLI, Codex CLI, or both.
|
|
79
96
|
|
|
80
97
|
```bash
|
|
81
98
|
npx clay-server
|
|
82
99
|
```
|
|
83
100
|
|
|
84
|
-
On first run,
|
|
85
|
-
Open the browser URL or scan the QR code to connect from your phone instantly.
|
|
101
|
+
On first run, Clay asks for a port and whether you're solo or with a team. Open the URL or scan the QR code from your phone.
|
|
86
102
|
|
|
87
103
|
For remote access, use a VPN like Tailscale.
|
|
88
104
|
|
|
@@ -90,84 +106,111 @@ For remote access, use a VPN like Tailscale.
|
|
|
90
106
|
<img src="media/start.gif" alt="Clay starting from CLI" width="600">
|
|
91
107
|
</p>
|
|
92
108
|
|
|
109
|
+
## CLI Options
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
npx clay-server # Default (port 2633)
|
|
113
|
+
npx clay-server -p 8080 # Specify port
|
|
114
|
+
npx clay-server --yes # Skip interactive prompts (use defaults)
|
|
115
|
+
npx clay-server -y --pin 123456
|
|
116
|
+
# Non-interactive + PIN (for scripts/CI)
|
|
117
|
+
npx clay-server --add . # Add current directory to running daemon
|
|
118
|
+
npx clay-server --remove . # Remove project
|
|
119
|
+
npx clay-server --list # List registered projects
|
|
120
|
+
npx clay-server --shutdown # Stop running daemon
|
|
121
|
+
npx clay-server --dangerously-skip-permissions
|
|
122
|
+
# Bypass all permission prompts (requires PIN at setup)
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Run `npx clay-server --help` for all options.
|
|
126
|
+
|
|
93
127
|
## FAQ
|
|
94
128
|
|
|
95
|
-
**"Is this
|
|
96
|
-
Clay
|
|
129
|
+
**"Is this a Claude Code wrapper?"**
|
|
130
|
+
No. Clay drives Claude Code through the [Claude Agent SDK](https://www.npmjs.com/package/@anthropic-ai/claude-agent-sdk) and Codex through the Codex app-server protocol. Both are first-class. Clay adds multi-session orchestration, persistent Mates, structured debates, scheduled agents, multi-user collaboration, built-in MCP servers, and a full browser UI on top.
|
|
131
|
+
|
|
132
|
+
**"Can I run Claude Code and Codex in the same workspace?"**
|
|
133
|
+
Yes. Pick a vendor when you open a session. Switch per session. Same projects, same Mates, same memory.
|
|
97
134
|
|
|
98
135
|
**"Does my code leave my machine?"**
|
|
99
|
-
|
|
136
|
+
Only as model API calls (the same as using the CLI directly). Sessions, Mates, knowledge, and settings all stay on disk.
|
|
100
137
|
|
|
101
|
-
**"
|
|
102
|
-
Yes.
|
|
138
|
+
**"Does my existing CLAUDE.md / AGENTS.md / .cursorrules work?"**
|
|
139
|
+
Yes. Clay loads native instruction files for each vendor and merges the rest into the system prompt automatically.
|
|
103
140
|
|
|
104
|
-
**"
|
|
105
|
-
Yes.
|
|
141
|
+
**"Can I continue a CLI session in the browser?"**
|
|
142
|
+
Yes. CLI sessions show up in the sidebar. Browser sessions can be picked up in the CLI.
|
|
106
143
|
|
|
107
144
|
**"Does each teammate need their own API key?"**
|
|
108
|
-
No.
|
|
145
|
+
No. Share one org-wide key, or let each user bring their own. On Linux with OS-level isolation, each member can also use their own Claude Code or Codex login.
|
|
146
|
+
|
|
147
|
+
**"What does OS-level isolation actually do?"**
|
|
148
|
+
On Linux, opt in and Clay provisions each user as a real Linux account. File ACLs are enforced via `setfacl`, agent processes spawn under the user's UID/GID, and the kernel handles the rest. One teammate can't read another's project files, even by accident. The guarantee comes from the OS, not from a promise in our code.
|
|
109
149
|
|
|
110
150
|
**"Does it work with MCP servers?"**
|
|
111
|
-
Yes.
|
|
151
|
+
Yes. User-configured MCPs from `~/.clay/mcp.json` plus built-in browser, email, ask-user, and debate servers. All work in both Claude and Codex sessions.
|
|
112
152
|
|
|
113
153
|
**"Can I use it on my phone?"**
|
|
114
|
-
Yes.
|
|
154
|
+
Yes. Install as a PWA on iOS or Android. Push notifications for approvals, errors, and task completion.
|
|
115
155
|
|
|
116
156
|
**"What is d.clay.studio in my browser URL?"**
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
## Why I built Clay
|
|
157
|
+
A DNS-only service that resolves to your local IP for HTTPS certificate validation. No data passes through it. All traffic stays between your browser and your machine. See [clay-dns](clay-dns/) for details.
|
|
120
158
|
|
|
121
|
-
|
|
159
|
+
## Our Philosophy
|
|
122
160
|
|
|
123
|
-
|
|
161
|
+
One idea: **user experience sovereignty**.
|
|
124
162
|
|
|
125
|
-
|
|
163
|
+
Not a grand statement. A simple wish: not to have your thinking, your work, and your data locked in the moment a vendor changes a price or rewrites a ToS.
|
|
126
164
|
|
|
127
|
-
That
|
|
165
|
+
That shows up in the technical choices we made:
|
|
128
166
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
npx clay-server -p 8080 # Specify port
|
|
134
|
-
npx clay-server --yes # Skip interactive prompts (use defaults)
|
|
135
|
-
npx clay-server -y --pin 123456
|
|
136
|
-
# Non-interactive + PIN (for scripts/CI)
|
|
137
|
-
npx clay-server --add . # Add current directory to running daemon
|
|
138
|
-
npx clay-server --remove . # Remove project
|
|
139
|
-
npx clay-server --list # List registered projects
|
|
140
|
-
npx clay-server --shutdown # Stop running daemon
|
|
141
|
-
npx clay-server --dangerously-skip-permissions
|
|
142
|
-
# Bypass all permission prompts (requires PIN at setup)
|
|
143
|
-
```
|
|
167
|
+
- **Your machine is the server.** Browser → your daemon → model API. That's the full chain. No vendor cloud, no relay server, no middle tier syncing your sessions through someone else's infrastructure.
|
|
168
|
+
- **One toggle between vendors.** The adapter layer (YOKE) speaks the Claude Agent SDK and the Codex app-server protocol natively. Switching is a setting, not a migration.
|
|
169
|
+
- **Plain text on disk.** Sessions, Mates, knowledge, and settings live as JSONL and Markdown. No proprietary database. You can `cat`, `grep`, version, and back up everything yourself.
|
|
170
|
+
- **Standard formats only.** CLAUDE.md, AGENTS.md, `.cursorrules`, MCP, Unix cron. If you walk away from Clay, your data walks with you in formats every other tool already understands.
|
|
144
171
|
|
|
145
|
-
|
|
172
|
+
That's the principle. The rest of the README is what it makes possible.
|
|
146
173
|
|
|
147
174
|
## Architecture
|
|
148
175
|
|
|
149
|
-
Clay drives
|
|
176
|
+
Clay is a self-hosted daemon. It drives Claude Code (via the [Claude Agent SDK](https://www.npmjs.com/package/@anthropic-ai/claude-agent-sdk)) and Codex (via the `codex app-server` JSON-RPC protocol) through a vendor-agnostic adapter layer (**YOKE**), and serves a multi-user web workspace over HTTP/WS. Sessions, Mates, and knowledge live as plain JSONL/Markdown on disk.
|
|
150
177
|
|
|
151
178
|
```mermaid
|
|
152
179
|
graph LR
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
180
|
+
subgraph Clients
|
|
181
|
+
B1["Browser<br/>User A"]
|
|
182
|
+
B2["Browser<br/>User B"]
|
|
183
|
+
Phone["Phone PWA<br/>+ Push"]
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
subgraph Daemon["Clay Daemon (your machine)"]
|
|
187
|
+
Auth["Auth + RBAC"]
|
|
188
|
+
Server["HTTP / WS Server"]
|
|
189
|
+
Project["Project Context"]
|
|
190
|
+
YOKE["YOKE Adapter Layer"]
|
|
191
|
+
MCP["Built-in MCP servers<br/>ask-user / browser /<br/>debate / email"]
|
|
192
|
+
Push["Push (VAPID)"]
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
subgraph Vendors["Agent runtimes"]
|
|
196
|
+
Claude["Claude Agent SDK"]
|
|
197
|
+
Codex["codex app-server<br/>(JSON-RPC stdio)"]
|
|
198
|
+
end
|
|
199
|
+
|
|
200
|
+
B1 <-->|WS| Server
|
|
201
|
+
B2 <-->|WS| Server
|
|
202
|
+
Phone <-->|WS + push| Server
|
|
203
|
+
Server --> Auth
|
|
204
|
+
Server --> Project
|
|
205
|
+
Project --> YOKE
|
|
206
|
+
Project --> MCP
|
|
207
|
+
Project --> Push
|
|
208
|
+
YOKE --> Claude
|
|
209
|
+
YOKE --> Codex
|
|
210
|
+
Push -.-> Phone
|
|
168
211
|
```
|
|
169
212
|
|
|
170
|
-
For
|
|
213
|
+
For sequence diagrams, OS-level isolation, daemon IPC, and key design decisions, see [docs/guides/architecture.md](docs/guides/architecture.md).
|
|
171
214
|
|
|
172
215
|
## Community Projects
|
|
173
216
|
|
|
@@ -195,7 +238,7 @@ If you're using Clay, let us know how in Discussions:
|
|
|
195
238
|
|
|
196
239
|
## Disclaimer
|
|
197
240
|
|
|
198
|
-
Not affiliated with Anthropic. Claude is a trademark of Anthropic. Provided "as is" without warranty. Users are responsible for complying with their AI provider's terms of service.
|
|
241
|
+
Not affiliated with Anthropic or OpenAI. Claude is a trademark of Anthropic. Codex is a trademark of OpenAI. Provided "as is" without warranty. Users are responsible for complying with their AI provider's terms of service.
|
|
199
242
|
|
|
200
243
|
## License
|
|
201
244
|
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "claude-relay",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.36.0-beta.1",
|
|
4
4
|
"description": "Alias for clay-server — Web UI for Claude Code.",
|
|
5
5
|
"bin": {
|
|
6
6
|
"claude-relay": "./bin/cli.js"
|
|
7
7
|
},
|
|
8
8
|
"dependencies": {
|
|
9
|
-
"clay-server": "2.
|
|
9
|
+
"clay-server": "2.36.0-beta.1"
|
|
10
10
|
},
|
|
11
11
|
"keywords": [
|
|
12
12
|
"claude",
|