agentwheel 0.7.0 → 0.8.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 +29 -9
- package/dist/index.js +4692 -764
- package/openpack.json +8 -0
- package/package.json +3 -1
- package/skills/agentwheel/SKILL.md +397 -0
package/openpack.json
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agentwheel",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "Weave skills, rules, and instructions across every AI agent.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -29,6 +29,8 @@
|
|
|
29
29
|
},
|
|
30
30
|
"files": [
|
|
31
31
|
"dist",
|
|
32
|
+
"skills",
|
|
33
|
+
"openpack.json",
|
|
32
34
|
"README.md",
|
|
33
35
|
"LICENSE"
|
|
34
36
|
],
|
|
@@ -0,0 +1,397 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: agentwheel
|
|
3
|
+
description: Use agentwheel to discover, install, sync, update, customize, eject, and uninstall agent skills, rules, instructions, commands, MCP, hooks, settings, and plugin artifacts across runtimes.
|
|
4
|
+
allowed-tools: [Bash]
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# agentwheel
|
|
8
|
+
|
|
9
|
+
Use this skill when a user wants to install, manage, update, remove, or inspect agent skills or other agentwheel-managed artifacts.
|
|
10
|
+
|
|
11
|
+
agentwheel is the control plane. It reads packages from sources, stages artifacts, plans changes for a runtime adapter, and writes only through `sync`. Treat runtime output directories as generated files.
|
|
12
|
+
|
|
13
|
+
## Safety Rules
|
|
14
|
+
|
|
15
|
+
- Prefer `agentwheel plan ...` or `agentwheel sync --dry-run` before applying changes.
|
|
16
|
+
- Do not hand-edit generated runtime files such as `.openclaw/skills`, `.claude/skills`, `.codex/skills`, `.hermes/skills`, or generated instructions.
|
|
17
|
+
- If a plan reports `drift` or `conflict`, stop and explain it. Do not use `--force` unless the user explicitly approves that scope.
|
|
18
|
+
- Gmail, Drive, registry publishing, git commits, pushes, and runtime restarts are separate external side effects. Get explicit approval for them.
|
|
19
|
+
- Programmatic adapters execute local code. Use `--adapter-module` only with `--allow-adapter-code` after the user approves that local code execution.
|
|
20
|
+
- OpenClaw plugin artifacts are only planned by default. Use `--execute-plugins` only after explicit approval.
|
|
21
|
+
|
|
22
|
+
## Core Flow
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
agentwheel registry search tmux
|
|
26
|
+
agentwheel add github:NestDevLab/agent-mesh --skill codex-tmux --adapter codex --mode tracking
|
|
27
|
+
agentwheel sync --dry-run
|
|
28
|
+
agentwheel sync
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
If a workspace already has configured packages in `.agentwheel/config.json`, run sync without a source:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
agentwheel sync --dry-run
|
|
35
|
+
agentwheel sync
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Workspace Setup
|
|
39
|
+
|
|
40
|
+
Initialize an agentwheel workspace:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
agentwheel init
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Initialize a package authoring directory:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
agentwheel init package
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
`agentwheel init package` creates `agentwheel.json`, `instructions/`, `rules/`, `skills/`, and `instructions/AGENTS.md`.
|
|
53
|
+
|
|
54
|
+
## Discovery
|
|
55
|
+
|
|
56
|
+
Refresh and search the optional registry:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
agentwheel registry update
|
|
60
|
+
agentwheel registry list
|
|
61
|
+
agentwheel registry search <query>
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Inspect an explicit source before adding it:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
agentwheel list github:owner/repo
|
|
68
|
+
agentwheel scan github:owner/repo
|
|
69
|
+
agentwheel list ./local-agent-pack
|
|
70
|
+
agentwheel scan ./local-agent-pack
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Filter discovery to specific artifacts:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
agentwheel list github:owner/repo --select skills/review --select rules/core.md
|
|
77
|
+
agentwheel list github:owner/repo --skill review
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Sources
|
|
81
|
+
|
|
82
|
+
Use explicit sources when you know the package location:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
agentwheel add github:owner/repo
|
|
86
|
+
agentwheel add github:owner/repo#main
|
|
87
|
+
agentwheel add git:https://host.example/owner/repo.git#v1.2.3
|
|
88
|
+
agentwheel add ./local-agent-pack
|
|
89
|
+
agentwheel add /absolute/path/to/agent-pack
|
|
90
|
+
agentwheel add skillkit:github:owner/repo
|
|
91
|
+
agentwheel add vercel:owner/repo
|
|
92
|
+
agentwheel add vercel:skills.sh/owner/repo/skill-name
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Short names go through the registry:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
agentwheel registry update
|
|
99
|
+
agentwheel add <registry-name>
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Driver inference is automatic for `github:`, `git:`, `skillkit:`, `vercel:`, and local paths. Override it only when needed:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
agentwheel add <source> --driver local
|
|
106
|
+
agentwheel add <source> --driver git
|
|
107
|
+
agentwheel add <source> --driver skillkit
|
|
108
|
+
agentwheel add <source> --driver vercel-skills
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Add Packages
|
|
112
|
+
|
|
113
|
+
Add saves a package entry in `.agentwheel/config.json`; it does not install runtime files by itself.
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
agentwheel add github:owner/repo --adapter openclaw
|
|
117
|
+
agentwheel add github:owner/repo --adapter claude
|
|
118
|
+
agentwheel add github:owner/repo --adapter codex
|
|
119
|
+
agentwheel add github:owner/repo --adapter hermes
|
|
120
|
+
agentwheel add github:owner/repo --adapter copilot
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
Select only part of a package:
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
agentwheel add github:owner/repo --skill code-review
|
|
127
|
+
agentwheel add github:owner/repo --select skills/code-review --select rules/core.md
|
|
128
|
+
agentwheel add github:owner/repo --select skills/code-review,rules/core.md
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Use `--name` for a stable local alias:
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
agentwheel add github:owner/repo --name team-agent-pack
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Choose update mode:
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
agentwheel add github:owner/repo#v1.0.0 --mode pinned
|
|
141
|
+
agentwheel add github:owner/repo#main --mode tracking
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## Plan And Sync
|
|
145
|
+
|
|
146
|
+
Plan a source directly:
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
agentwheel plan github:owner/repo --adapter codex
|
|
150
|
+
agentwheel plan github:owner/repo --adapter codex --target-root /path/to/project
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
Dry-run a source directly:
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
agentwheel sync github:owner/repo --adapter codex --dry-run
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
Apply a source directly:
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
agentwheel sync github:owner/repo --adapter codex
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
Sync configured packages:
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
agentwheel sync --dry-run
|
|
169
|
+
agentwheel sync
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Target selection order is `--target-root`, then `--agent`, then runtime auto-detection from the current directory, then the current directory.
|
|
173
|
+
|
|
174
|
+
## Named Agents And Profiles
|
|
175
|
+
|
|
176
|
+
Global config is `~/.agentwheel/config.json`. Project config is `.agentwheel/config.json`; project values win.
|
|
177
|
+
|
|
178
|
+
Current config shape:
|
|
179
|
+
|
|
180
|
+
```json
|
|
181
|
+
{
|
|
182
|
+
"schemaVersion": 1,
|
|
183
|
+
"packages": [],
|
|
184
|
+
"registry": {},
|
|
185
|
+
"agents": {
|
|
186
|
+
"lab-codex": { "adapter": "codex", "root": "/Users/me/project" },
|
|
187
|
+
"lab-claude": { "adapter": "claude", "root": "/Users/me/project" }
|
|
188
|
+
},
|
|
189
|
+
"profiles": {
|
|
190
|
+
"daily": {
|
|
191
|
+
"runtimes": [
|
|
192
|
+
{ "agent": "lab-codex" },
|
|
193
|
+
{ "agent": "lab-claude" }
|
|
194
|
+
]
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
Use named targets:
|
|
201
|
+
|
|
202
|
+
```bash
|
|
203
|
+
agentwheel sync --agent lab-codex --dry-run
|
|
204
|
+
agentwheel sync --agent lab-codex
|
|
205
|
+
agentwheel sync --all --dry-run
|
|
206
|
+
agentwheel sync --all
|
|
207
|
+
agentwheel sync --profile daily --dry-run
|
|
208
|
+
agentwheel sync --profile daily
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
## Adapters
|
|
212
|
+
|
|
213
|
+
Built-in adapters:
|
|
214
|
+
|
|
215
|
+
- `openclaw`
|
|
216
|
+
- `claude`
|
|
217
|
+
- `codex`
|
|
218
|
+
- `hermes`
|
|
219
|
+
- `copilot`
|
|
220
|
+
|
|
221
|
+
Use a declarative adapter config:
|
|
222
|
+
|
|
223
|
+
```bash
|
|
224
|
+
agentwheel sync ./my-pack --adapter-config ./my-runtime.jsonc --dry-run
|
|
225
|
+
agentwheel sync ./my-pack --adapter-config ./my-runtime.jsonc
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
Use a local programmatic adapter only after approval:
|
|
229
|
+
|
|
230
|
+
```bash
|
|
231
|
+
agentwheel sync ./my-pack --adapter-module ./adapter.ts --allow-adapter-code --dry-run
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
## Update
|
|
235
|
+
|
|
236
|
+
Preview updates for configured packages:
|
|
237
|
+
|
|
238
|
+
```bash
|
|
239
|
+
agentwheel update --dry-run
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
Apply updates:
|
|
243
|
+
|
|
244
|
+
```bash
|
|
245
|
+
agentwheel update
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
Target configured agents:
|
|
249
|
+
|
|
250
|
+
```bash
|
|
251
|
+
agentwheel update --agent lab-codex --dry-run
|
|
252
|
+
agentwheel update --all --dry-run
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
Temporarily limit an update to selected artifacts:
|
|
256
|
+
|
|
257
|
+
```bash
|
|
258
|
+
agentwheel update --skill code-review --dry-run
|
|
259
|
+
agentwheel update --select skills/code-review --dry-run
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
`update` skips pinned packages unless the lock indicates they should be updated. Tracking packages can re-resolve upstream.
|
|
263
|
+
|
|
264
|
+
## Drift And Customization
|
|
265
|
+
|
|
266
|
+
Drift means a managed runtime output changed outside agentwheel. Fix drift by choosing one of the supported customization channels in `.agentwheel/`, then re-run a dry-run:
|
|
267
|
+
|
|
268
|
+
- Layer local instructions with `agentwheel remember`.
|
|
269
|
+
- Add separate local artifacts under `.agentwheel/additions`.
|
|
270
|
+
- Override an upstream item under `.agentwheel/overrides`.
|
|
271
|
+
- Eject an item into `.agentwheel/ejected` when the user wants local ownership.
|
|
272
|
+
|
|
273
|
+
Append durable local instruction text:
|
|
274
|
+
|
|
275
|
+
```bash
|
|
276
|
+
agentwheel remember --runtime codex "Always run the formatter before tests."
|
|
277
|
+
agentwheel sync --dry-run
|
|
278
|
+
agentwheel sync
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
Eject an artifact:
|
|
282
|
+
|
|
283
|
+
```bash
|
|
284
|
+
agentwheel eject <package-name>/skills/<skill-name>
|
|
285
|
+
agentwheel sync --dry-run
|
|
286
|
+
agentwheel sync
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
For package names with slashes, keep the full package name:
|
|
290
|
+
|
|
291
|
+
```bash
|
|
292
|
+
agentwheel eject NestDevLab/agent-mesh/skills/codex-tmux
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
## Uninstall
|
|
296
|
+
|
|
297
|
+
Preview uninstall for the current target:
|
|
298
|
+
|
|
299
|
+
```bash
|
|
300
|
+
agentwheel uninstall --dry-run
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
Uninstall clean managed files:
|
|
304
|
+
|
|
305
|
+
```bash
|
|
306
|
+
agentwheel uninstall
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
Uninstall a selected skill:
|
|
310
|
+
|
|
311
|
+
```bash
|
|
312
|
+
agentwheel uninstall --skill code-review --dry-run
|
|
313
|
+
agentwheel uninstall --skill code-review
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
Uninstall a selected artifact:
|
|
317
|
+
|
|
318
|
+
```bash
|
|
319
|
+
agentwheel uninstall --select skills/code-review --dry-run
|
|
320
|
+
agentwheel uninstall --select skills/code-review
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
By default, uninstall keeps drifted managed files. Use `--force` only with explicit approval:
|
|
324
|
+
|
|
325
|
+
```bash
|
|
326
|
+
agentwheel uninstall --force
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
## Package Manifest Reference
|
|
330
|
+
|
|
331
|
+
An agentwheel package uses `agentwheel.json` or `agentwheel.jsonc`:
|
|
332
|
+
|
|
333
|
+
```json
|
|
334
|
+
{
|
|
335
|
+
"schemaVersion": 1,
|
|
336
|
+
"name": "owner/agent-pack",
|
|
337
|
+
"version": "0.1.0",
|
|
338
|
+
"provides": [
|
|
339
|
+
{ "type": "instructions", "path": "instructions/AGENTS.md" },
|
|
340
|
+
{ "type": "rules", "path": "rules" },
|
|
341
|
+
{ "type": "skills", "path": "skills" }
|
|
342
|
+
]
|
|
343
|
+
}
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
Supported artifact types are `instructions`, `rules`, `skills`, `commands`, `subagents`, `mcp`, `hooks`, `settings`, and `plugins`.
|
|
347
|
+
|
|
348
|
+
Skills convention:
|
|
349
|
+
|
|
350
|
+
```text
|
|
351
|
+
skills/<name>/SKILL.md
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
Skill frontmatter is YAML:
|
|
355
|
+
|
|
356
|
+
```yaml
|
|
357
|
+
---
|
|
358
|
+
name: code-review
|
|
359
|
+
description: Review code, configuration, or documentation for correctness, safety, maintainability, and missing validation.
|
|
360
|
+
allowed-tools: [Bash]
|
|
361
|
+
---
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
## Troubleshooting
|
|
365
|
+
|
|
366
|
+
If there are no configured packages:
|
|
367
|
+
|
|
368
|
+
```bash
|
|
369
|
+
agentwheel add <source> --adapter <runtime>
|
|
370
|
+
agentwheel sync --dry-run
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
If the current directory has multiple runtime markers:
|
|
374
|
+
|
|
375
|
+
```bash
|
|
376
|
+
agentwheel sync --adapter codex --dry-run
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
If a selected artifact is missing:
|
|
380
|
+
|
|
381
|
+
```bash
|
|
382
|
+
agentwheel list <source>
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
If registry short names fail:
|
|
386
|
+
|
|
387
|
+
```bash
|
|
388
|
+
agentwheel registry update
|
|
389
|
+
agentwheel registry search <query>
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
If npm update checks are noisy:
|
|
393
|
+
|
|
394
|
+
```bash
|
|
395
|
+
agentwheel --no-update-check sync --dry-run
|
|
396
|
+
AGENTWHEEL_NO_UPDATE_CHECK=1 agentwheel sync --dry-run
|
|
397
|
+
```
|