glm-coding-router 0.5.0 → 1.1.0
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 +419 -381
- package/dist/bin/glm-mcp.js +25 -0
- package/dist/bin/glm-worker.js +37 -4
- package/dist/cli.js +13 -0
- package/dist/commands/doctor.js +31 -14
- package/dist/commands/init.js +5 -3
- package/dist/commands/key.js +46 -9
- package/dist/commands/mcp.js +72 -0
- package/dist/commands/skill.js +48 -36
- package/dist/commands/status.js +21 -8
- package/dist/commands/uninstall.js +2 -1
- package/dist/commands/usage.js +1 -1
- package/dist/core/config.js +31 -2
- package/dist/core/errors.js +33 -10
- package/dist/core/platform.js +37 -8
- package/dist/core/profile.js +6 -1
- package/dist/core/user-env.js +181 -0
- package/dist/core/zai-key.js +15 -59
- package/dist/integrations/skill.js +31 -12
- package/dist/mcp/server.js +232 -0
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,381 +1,419 @@
|
|
|
1
|
-
# GLM Coding Router
|
|
2
|
-
|
|
3
|
-
GLM Coding Plan workers for Claude Code and Codex
|
|
4
|
-
|
|
5
|
-
Claude Code and Codex stay your orchestrators — they keep responsibility for requirements,
|
|
6
|
-
architecture, review, and integration. `glm-coding-router` delegates well-scoped
|
|
7
|
-
implementation work (exploration, CRUD, boilerplate, tests, mechanical refactoring) to
|
|
8
|
-
GLM workers via Z.ai's Anthropic-compatible endpoint.
|
|
9
|
-
|
|
10
|
-
One global npm install replaces the manual `.cmd` shim setup:
|
|
11
|
-
|
|
12
|
-
```text
|
|
13
|
-
Claude / Codex → shell → glm-worker → claude.exe harness → Z.ai endpoint → GLM Coding Plan
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Architecture
|
|
17
|
-
|
|
18
|
-
```text
|
|
19
|
-
Developer
|
|
20
|
-
│
|
|
21
|
-
┌───────────────┴───────────────┐
|
|
22
|
-
▼ ▼
|
|
23
|
-
Claude Code Codex
|
|
24
|
-
│ │
|
|
25
|
-
└───────────────┬───────────────┘
|
|
26
|
-
shell command
|
|
27
|
-
│
|
|
28
|
-
┌───────────────┼───────────────┐
|
|
29
|
-
▼ ▼ ▼
|
|
30
|
-
glm-chat glm-fast glm-worker glm-review
|
|
31
|
-
│ │ │ │
|
|
32
|
-
└─────────┴──────────┴──────────┘
|
|
33
|
-
claude.exe
|
|
34
|
-
(injected environment only)
|
|
35
|
-
│
|
|
36
|
-
▼
|
|
37
|
-
https://api.z.ai/api/anthropic
|
|
38
|
-
│
|
|
39
|
-
▼
|
|
40
|
-
GLM Coding Plan
|
|
41
|
-
GLM-5.3 / GLM-5.3-Flash
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
## Requirements
|
|
45
|
-
|
|
46
|
-
- Windows 10/11 (
|
|
47
|
-
|
|
48
|
-
-
|
|
49
|
-
-
|
|
50
|
-
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
glm-router
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
glm-
|
|
71
|
-
glm-
|
|
72
|
-
glm-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
glm-chat
|
|
84
|
-
glm-chat --
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
glm-fast
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
"
|
|
150
|
-
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
glm-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
`--profile`
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
[glm-router]
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
glm-router delegate
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
glm-router benchmark --yes
|
|
213
|
-
glm-router benchmark --yes --
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
**
|
|
219
|
-
(
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
`
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
glm-router
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
glm-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
-
|
|
327
|
-
-
|
|
328
|
-
|
|
329
|
-
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
##
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
`
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
1
|
+
# GLM Coding Router
|
|
2
|
+
|
|
3
|
+
GLM Coding Plan workers for Claude Code and Codex — on Windows, Linux, and (experimentally) macOS.
|
|
4
|
+
|
|
5
|
+
Claude Code and Codex stay your orchestrators — they keep responsibility for requirements,
|
|
6
|
+
architecture, review, and integration. `glm-coding-router` delegates well-scoped
|
|
7
|
+
implementation work (exploration, CRUD, boilerplate, tests, mechanical refactoring) to
|
|
8
|
+
GLM workers via Z.ai's Anthropic-compatible endpoint.
|
|
9
|
+
|
|
10
|
+
One global npm install replaces the manual `.cmd` shim setup:
|
|
11
|
+
|
|
12
|
+
```text
|
|
13
|
+
Claude / Codex → shell → glm-worker → claude.exe harness → Z.ai endpoint → GLM Coding Plan
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Architecture
|
|
17
|
+
|
|
18
|
+
```text
|
|
19
|
+
Developer
|
|
20
|
+
│
|
|
21
|
+
┌───────────────┴───────────────┐
|
|
22
|
+
▼ ▼
|
|
23
|
+
Claude Code Codex
|
|
24
|
+
│ │
|
|
25
|
+
└───────────────┬───────────────┘
|
|
26
|
+
shell command
|
|
27
|
+
│
|
|
28
|
+
┌───────────────┼───────────────┐
|
|
29
|
+
▼ ▼ ▼
|
|
30
|
+
glm-chat glm-fast glm-worker glm-review
|
|
31
|
+
│ │ │ │
|
|
32
|
+
└─────────┴──────────┴──────────┘
|
|
33
|
+
claude.exe
|
|
34
|
+
(injected environment only)
|
|
35
|
+
│
|
|
36
|
+
▼
|
|
37
|
+
https://api.z.ai/api/anthropic
|
|
38
|
+
│
|
|
39
|
+
▼
|
|
40
|
+
GLM Coding Plan
|
|
41
|
+
GLM-5.3 / GLM-5.3-Flash
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Requirements
|
|
45
|
+
|
|
46
|
+
- Windows 10/11 or Linux (both verified); macOS is experimental — the suite has not been
|
|
47
|
+
run on a Mac
|
|
48
|
+
- Node.js >= 20
|
|
49
|
+
- Claude Code (`claude.exe`) — the GLM commands run on the Claude Code harness
|
|
50
|
+
- Codex (optional — Claude-only setups are fully supported)
|
|
51
|
+
- A Z.ai Coding Plan API key
|
|
52
|
+
|
|
53
|
+
No Anthropic pay-as-you-go, no OpenAI API, no LiteLLM, no proxy.
|
|
54
|
+
|
|
55
|
+
## Installation
|
|
56
|
+
|
|
57
|
+
```powershell
|
|
58
|
+
npm install -g glm-coding-router
|
|
59
|
+
glm-router init
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
`npx glm-coding-router init` also works for a one-off check, but the global install is
|
|
63
|
+
what puts `glm-worker` on your PATH long-term.
|
|
64
|
+
|
|
65
|
+
## Quick start
|
|
66
|
+
|
|
67
|
+
After `glm-router init`:
|
|
68
|
+
|
|
69
|
+
```powershell
|
|
70
|
+
glm-chat
|
|
71
|
+
glm-fast
|
|
72
|
+
glm-worker "Implement validation and add tests"
|
|
73
|
+
glm-review "Analyze the auth module"
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## glm-chat
|
|
77
|
+
|
|
78
|
+
Interactive GLM-backed Claude Code session. Resolves the Z.ai key, locates `claude.exe`,
|
|
79
|
+
injects the Z.ai environment **into the child process only**, and spawns it with
|
|
80
|
+
pass-through arguments:
|
|
81
|
+
|
|
82
|
+
```powershell
|
|
83
|
+
glm-chat
|
|
84
|
+
glm-chat --version
|
|
85
|
+
glm-chat --any-claude-flag
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Your normal `claude` command and its authentication are untouched.
|
|
89
|
+
|
|
90
|
+
## glm-fast
|
|
91
|
+
|
|
92
|
+
Interactive GLM-backed session pinned to the **fast model** (`models.fast`,
|
|
93
|
+
`glm-5.3-flash` by default) — every model slot in the child environment maps to
|
|
94
|
+
it, so whichever tier Claude Code picks, it gets the fast model. Same pass-through
|
|
95
|
+
arguments as `glm-chat`:
|
|
96
|
+
|
|
97
|
+
```powershell
|
|
98
|
+
glm-fast
|
|
99
|
+
glm-fast --profile air
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## glm-worker
|
|
103
|
+
|
|
104
|
+
Headless implementation worker:
|
|
105
|
+
|
|
106
|
+
```powershell
|
|
107
|
+
glm-worker "Implement validation and add tests"
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Or via stdin (a structured task packet):
|
|
111
|
+
|
|
112
|
+
```powershell
|
|
113
|
+
@"
|
|
114
|
+
TASK:
|
|
115
|
+
Implement refresh token validation.
|
|
116
|
+
|
|
117
|
+
SCOPE:
|
|
118
|
+
internal/auth/
|
|
119
|
+
|
|
120
|
+
VALIDATION:
|
|
121
|
+
go test ./internal/auth/...
|
|
122
|
+
"@ | glm-worker
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Input priority: **stdin → arguments → error**. The worker runs with
|
|
126
|
+
`--max-turns 20 --permission-mode acceptEdits --tools Read,Glob,Grep,Edit,Write,Bash`.
|
|
127
|
+
It never uses `--dangerously-skip-permissions`.
|
|
128
|
+
|
|
129
|
+
## glm-review
|
|
130
|
+
|
|
131
|
+
Read-only worker for repository exploration, call-graph discovery, duplicate detection,
|
|
132
|
+
dependency inspection, and preliminary review:
|
|
133
|
+
|
|
134
|
+
```powershell
|
|
135
|
+
glm-review "Inspect this repository"
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
Runs with `--tools Read,Glob,Grep` — it cannot edit files or run commands.
|
|
139
|
+
|
|
140
|
+
## Profiles
|
|
141
|
+
|
|
142
|
+
All four task binaries (`glm-chat`, `glm-fast`, `glm-worker`, `glm-review`)
|
|
143
|
+
accept `--profile <name>` to overlay saved model/maxTurns settings. Profiles
|
|
144
|
+
live in `config.json`:
|
|
145
|
+
|
|
146
|
+
```json
|
|
147
|
+
{
|
|
148
|
+
"profiles": {
|
|
149
|
+
"test": { "workerMaxTurns": 10, "fast": "glm-5.3-flash" },
|
|
150
|
+
"frontend": { "main": "glm-5.3", "reviewMaxTurns": 30 }
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
```powershell
|
|
156
|
+
glm-worker --profile test "Add failing test then fix it"
|
|
157
|
+
glm-review --profile frontend "Review the component tree"
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
Fields (all optional): `main`, `fast`, `workerMaxTurns`, `reviewMaxTurns`.
|
|
161
|
+
Unknown profile names fail with `ERROR [11]` listing the available ones.
|
|
162
|
+
Note: `--profile` belongs to these wrappers — it shadows Claude Code's own
|
|
163
|
+
`--profile` flag inside them.
|
|
164
|
+
|
|
165
|
+
## delegate
|
|
166
|
+
|
|
167
|
+
Run a GLM worker in an **isolated git worktree** so parallel tasks never trample
|
|
168
|
+
each other's working tree (`glm-router delegate backend|frontend|tests`):
|
|
169
|
+
|
|
170
|
+
```powershell
|
|
171
|
+
glm-router delegate backend "Implement refresh token validation in internal/auth"
|
|
172
|
+
Get-Content task.md | glm-router delegate auth-refresh
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Each run creates a worktree at `<repo>.glm-worktrees\<name>` (outside the repo,
|
|
176
|
+
so your checkout's status stays clean) on a new branch `glm/delegate/<name>`
|
|
177
|
+
cut from `HEAD`, and runs the standard `glm-worker` inside it. The worktree and
|
|
178
|
+
branch are **kept** after the run — the tool never commits, merges, or deletes
|
|
179
|
+
your work; the footer prints the path and the merge command:
|
|
180
|
+
|
|
181
|
+
```text
|
|
182
|
+
[glm-router] worktree kept at D:\code\my-repo.glm-worktrees\backend
|
|
183
|
+
[glm-router] next: inspect it, then merge glm/delegate/backend (or discard with git worktree remove)
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
- Prompt priority is stdin → arguments, same as `glm-worker`.
|
|
187
|
+
- Profiles: `--profile test` explicitly, or — when omitted — a profile literally
|
|
188
|
+
named after the delegate (`delegate test` → the `test` profile) if one exists.
|
|
189
|
+
- `--remove` deletes the worktree **after a successful run only**; plain
|
|
190
|
+
`git worktree remove` is used, so git refuses (and the worktree is kept) when
|
|
191
|
+
the worker left uncommitted changes. The branch is always kept.
|
|
192
|
+
- Pre-flight checks fail fast (`ERROR [31]`) when the branch or directory
|
|
193
|
+
already exists, or the repo has no commits yet; outside a git repo →
|
|
194
|
+
`ERROR [30]`. Uncommitted changes in your main checkout are **not** visible
|
|
195
|
+
to the worker — it starts from the last commit.
|
|
196
|
+
- `--dry-run` prints the plan; `--json` prints pre-flight and result objects.
|
|
197
|
+
- Run several delegates concurrently — distinct names cannot collide:
|
|
198
|
+
|
|
199
|
+
```powershell
|
|
200
|
+
glm-router delegate backend "Task A" # terminal 1
|
|
201
|
+
glm-router delegate tests "Task B" # terminal 2
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
## benchmark
|
|
205
|
+
|
|
206
|
+
Measure the Claude Code + GLM stack on built-in coding tasks (spec §54 v0.4).
|
|
207
|
+
Each task runs in a throwaway temp directory: the router writes the task files,
|
|
208
|
+
spawns the standard GLM worker (same env injection, plus `--output-format json`
|
|
209
|
+
to capture the result document), then runs the task's validation command:
|
|
210
|
+
|
|
211
|
+
```powershell
|
|
212
|
+
glm-router benchmark --yes # both built-in tasks, 1 run each
|
|
213
|
+
glm-router benchmark --yes --task fn-reverse --repeat 3
|
|
214
|
+
glm-router benchmark --yes --max-turns 15
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
Report (per task × run): **duration**, **GLM calls** (assistant turns),
|
|
218
|
+
**retries** (`-` — not exposed by Claude Code yet), **tokens in/out**,
|
|
219
|
+
**tests** (PASS/FAIL of `node test.js`), **success**, **intervention**
|
|
220
|
+
(`needed` when the run did not self-complete). The full JSON report is always
|
|
221
|
+
saved to `%USERPROFILE%\.glm-coding-router\benchmarks\benchmark-<timestamp>.json`
|
|
222
|
+
and `--json` also prints it.
|
|
223
|
+
|
|
224
|
+
Built-in tasks: `fn-reverse` (implement `reverseWords` until the test passes),
|
|
225
|
+
`fix-bug` (repair an even-length `median` bug).
|
|
226
|
+
|
|
227
|
+
Notes:
|
|
228
|
+
- Benchmarking makes **real GLM API calls** — interactive runs ask for
|
|
229
|
+
confirmation; non-interactive runs require `--yes`.
|
|
230
|
+
- Failed tasks are measurements, not errors: the command exits 0 once the
|
|
231
|
+
suite ran. Missing key/claude or a broken spawn still fail with the usual
|
|
232
|
+
`ERROR [10]/[20]/[40]`.
|
|
233
|
+
- `--stack codex` is recognized but not supported yet (headless Codex
|
|
234
|
+
orchestration isn't drivable today); the harness is stack-shaped so it can
|
|
235
|
+
be added later.
|
|
236
|
+
|
|
237
|
+
## usage
|
|
238
|
+
|
|
239
|
+
Provider usage snapshots (spec §54 v0.5) — what is reliably retrievable:
|
|
240
|
+
|
|
241
|
+
```powershell
|
|
242
|
+
glm-router usage
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
- **Z.ai Coding Plan quota** (network): queries the Z.ai monitor endpoint
|
|
246
|
+
(`/api/monitor/usage/quota/limit`) with your key and shows each credit
|
|
247
|
+
window — consumed/total, percentage, reset time — plus the plan level.
|
|
248
|
+
Unreachable endpoint or a rejected request renders `✗ <reason>` and exits 1.
|
|
249
|
+
- **Local totals** (offline): aggregates saved benchmark reports — run count
|
|
250
|
+
and summed input/output tokens (`glm-router benchmark` writes them).
|
|
251
|
+
- **Claude quota / Codex usage**: always shown as "not available" — neither
|
|
252
|
+
exposes a headless usage API today (and claude.ai quota is irrelevant while
|
|
253
|
+
traffic is routed to GLM).
|
|
254
|
+
|
|
255
|
+
`--json` emits the same data machine-readably. No key configured → `ERROR [10]`.
|
|
256
|
+
|
|
257
|
+
## Agent skills (Claude Code + Codex)
|
|
258
|
+
|
|
259
|
+
`glm-router skill install` writes the `glm-delegation` SKILL.md into **both**
|
|
260
|
+
agent homes — `~/.claude/skills/` and `~/.codex/skills/` — so either
|
|
261
|
+
orchestrator natively knows how to delegate to GLM workers. Missing homes are
|
|
262
|
+
skipped with a note (optional enhancement, never fatal); `skill remove`
|
|
263
|
+
cleans both. `status` shows one skill row per agent.
|
|
264
|
+
|
|
265
|
+
## MCP server (optional)
|
|
266
|
+
|
|
267
|
+
`glm-mcp` (installed with the package) exposes the router as MCP tools over
|
|
268
|
+
stdio — any MCP client can delegate without shell syntax:
|
|
269
|
+
|
|
270
|
+
| Tool | What it does |
|
|
271
|
+
|---|---|
|
|
272
|
+
| `glm_worker(prompt, profile?)` | implementation worker, returns output |
|
|
273
|
+
| `glm_review(prompt, profile?)` | read-only review/exploration |
|
|
274
|
+
| `glm_delegate(name, prompt)` | worker in an isolated git worktree |
|
|
275
|
+
| `glm_usage()` | Z.ai quota windows + local benchmark totals |
|
|
276
|
+
|
|
277
|
+
Register it with Claude Code (we never edit `~/.claude.json` ourselves — it
|
|
278
|
+
goes through Claude's own CLI):
|
|
279
|
+
|
|
280
|
+
```powershell
|
|
281
|
+
glm-router mcp # prints the snippet + the exact command
|
|
282
|
+
glm-router mcp install # claude mcp add -s user glm-coding-router -- node .../glm-mcp.js
|
|
283
|
+
glm-router mcp remove # claude mcp remove -s user glm-coding-router
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
Tool-level failures return `isError` results (missing key, no claude, outside
|
|
287
|
+
a git repo, unreachable endpoint); the server never prints anything to stdout
|
|
288
|
+
except JSON-RPC frames.
|
|
289
|
+
|
|
290
|
+
## CLI reference
|
|
291
|
+
|
|
292
|
+
```text
|
|
293
|
+
glm-router init guided setup
|
|
294
|
+
glm-router doctor [--network] full runtime diagnosis
|
|
295
|
+
glm-router status quick offline overview
|
|
296
|
+
glm-router key set store ZAI_API_KEY in this platform's per-user store
|
|
297
|
+
glm-router key check key configured? from which source?
|
|
298
|
+
glm-router config show
|
|
299
|
+
glm-router config set models.main glm-5.3
|
|
300
|
+
glm-router delegate <name> run a GLM worker in an isolated git worktree
|
|
301
|
+
glm-router benchmark measure the Claude+GLM stack on built-in tasks
|
|
302
|
+
glm-router usage Z.ai quota snapshot + local benchmark totals
|
|
303
|
+
glm-router mcp optional MCP server registration (glm-mcp)
|
|
304
|
+
glm-router project init CLAUDE.md / AGENTS.md managed blocks (--dry-run supported)
|
|
305
|
+
glm-router project remove
|
|
306
|
+
glm-router skill install optional Codex delegation skill
|
|
307
|
+
glm-router skill remove
|
|
308
|
+
glm-router uninstall guided removal (keeps ZAI_API_KEY by default)
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
Global flags: `--json --quiet --verbose --dry-run --force --yes`
|
|
312
|
+
|
|
313
|
+
## Claude integration
|
|
314
|
+
|
|
315
|
+
`glm-router project init` adds a **managed block** to `CLAUDE.md` at the project root
|
|
316
|
+
(`git rev-parse --show-toplevel`, falling back to cwd):
|
|
317
|
+
|
|
318
|
+
```text
|
|
319
|
+
<!-- glm-coding-router:start -->
|
|
320
|
+
... delegation policy ...
|
|
321
|
+
<!-- glm-coding-router:end -->
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
- Everything outside the markers is preserved; existing blocks are replaced in place;
|
|
325
|
+
runs are idempotent and never duplicate.
|
|
326
|
+
- Files are updated atomically (tmp file → fsync → rename).
|
|
327
|
+
- On a malformed marker pair the file is left untouched with an actionable error.
|
|
328
|
+
- CRLF/LF and UTF-8 are preserved.
|
|
329
|
+
- `glm-router project remove` deletes only the managed block. A file the router
|
|
330
|
+
created entirely is deleted only when it would otherwise be empty.
|
|
331
|
+
|
|
332
|
+
## Codex integration
|
|
333
|
+
|
|
334
|
+
The same command updates `AGENTS.md` (Codex's repository instruction file) with an
|
|
335
|
+
equivalent managed block. Additionally, `glm-router skill install` installs the optional
|
|
336
|
+
`glm-delegation` skill to `~/.codex/skills/glm-delegation/SKILL.md`. If Codex is not
|
|
337
|
+
detected, the skill step warns and skips — AGENTS.md integration and the core tool are
|
|
338
|
+
unaffected.
|
|
339
|
+
|
|
340
|
+
## Orca behavior (stale environments)
|
|
341
|
+
|
|
342
|
+
Terminals embedded in Orca snapshot the Windows environment at startup. A key added
|
|
343
|
+
after Orca starts is invisible to those terminals. Every GLM command therefore resolves
|
|
344
|
+
the key in this order:
|
|
345
|
+
|
|
346
|
+
1. `process.env.ZAI_API_KEY`
|
|
347
|
+
2. This platform's per-user store — Windows User Environment (PowerShell), macOS login
|
|
348
|
+
keychain (`security`), or libsecret (`secret-tool`, when installed)
|
|
349
|
+
3. fail with an actionable error
|
|
350
|
+
|
|
351
|
+
The key is never cached to disk.
|
|
352
|
+
|
|
353
|
+
## Security model
|
|
354
|
+
|
|
355
|
+
- The key lives only in that per-user store; it is never written to
|
|
356
|
+
`config.json`, the repo, logs, or stack traces. Debug output redacts
|
|
357
|
+
`ZAI_API_KEY`, `ANTHROPIC_AUTH_TOKEN`, and Authorization headers.
|
|
358
|
+
- Z.ai routing environment variables (`ANTHROPIC_AUTH_TOKEN`,
|
|
359
|
+
`ANTHROPIC_BASE_URL`, model overrides) are injected **only** into the spawned
|
|
360
|
+
`claude.exe` child process. `ANTHROPIC_API_KEY` is blanked in the child so your
|
|
361
|
+
normal Claude auth is never in play. `ANTHROPIC_BASE_URL` is never persisted globally.
|
|
362
|
+
- Claude Code and Codex global authentication are never modified.
|
|
363
|
+
- Child processes are spawned with argument arrays (`shell: false`) — prompts with
|
|
364
|
+
quotes, pipes, ampersands, or newlines are passed verbatim, never through a shell.
|
|
365
|
+
- No telemetry, no automatic git commits.
|
|
366
|
+
|
|
367
|
+
## Troubleshooting
|
|
368
|
+
|
|
369
|
+
| Symptom | Fix |
|
|
370
|
+
| --- | --- |
|
|
371
|
+
| `ERROR [ZAI_KEY_MISSING]` | `glm-router key set`, then open a **new** terminal |
|
|
372
|
+
| `ERROR [CLAUDE_NOT_FOUND]` | Install Claude Code, or `glm-router config set claudePath C:\path\to\claude.exe` |
|
|
373
|
+
| Key works in a new terminal but not inside Orca | Expected — workers re-read the per-user store automatically; run `glm-router doctor` to confirm |
|
|
374
|
+
| `glm-router key set` prints an `export` line instead of saving | This platform has no secret store (e.g. Linux without `secret-tool`). Add the line to your shell profile; `glm-router key check` verifies it |
|
|
375
|
+
| The worker creates files but never runs the tests | Its Bash allowlist is empty. `glm-router config show` → `worker.allowedBash`; the default list covers common test commands |
|
|
376
|
+
| `glm-*` not on PATH after install | Reopen the terminal; check `npm config get prefix` is on PATH |
|
|
377
|
+
| `ERROR [MANAGED_BLOCK_CORRUPT]` | Fix the marker pair in the named file manually, then re-run |
|
|
378
|
+
|
|
379
|
+
Run `glm-router doctor` (add `--network` to probe the Z.ai endpoint) for a full diagnosis.
|
|
380
|
+
|
|
381
|
+
## Uninstall
|
|
382
|
+
|
|
383
|
+
```powershell
|
|
384
|
+
glm-router uninstall
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
The wizard removes the config, the Codex skill, and optionally the current project
|
|
388
|
+
integration. `ZAI_API_KEY` is **kept** by default — removing credentials requires
|
|
389
|
+
explicit consent. Finish with `npm uninstall -g glm-coding-router`.
|
|
390
|
+
|
|
391
|
+
## Development
|
|
392
|
+
|
|
393
|
+
```powershell
|
|
394
|
+
npm install
|
|
395
|
+
npm run build # tsc → dist/
|
|
396
|
+
npm test # vitest run
|
|
397
|
+
npm run lint # eslint src tests
|
|
398
|
+
npm run dev # tsx src/cli.ts <args>
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
Integration tests spawn `tests/fixtures/fake-agent.mjs` (via `node.exe`) to verify
|
|
402
|
+
argument passing, environment injection, and exit-code propagation without spending
|
|
403
|
+
API quota. See the `docs/GLM Coding Router — Technical Specification v0.1.md` for the full
|
|
404
|
+
v0.1 contract (exit codes, managed-block test matrix, acceptance criteria).
|
|
405
|
+
|
|
406
|
+
## Publishing
|
|
407
|
+
|
|
408
|
+
```powershell
|
|
409
|
+
npm run build
|
|
410
|
+
npm test
|
|
411
|
+
npm publish
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
`prepublishOnly` runs build + tests. The package ships only `dist/`; the four binaries
|
|
415
|
+
(`glm-router`, `glm-chat`, `glm-fast`, `glm-worker`, `glm-review`) are declared in `bin`.
|
|
416
|
+
|
|
417
|
+
## License
|
|
418
|
+
|
|
419
|
+
MIT
|