agentwheel 0.14.3 → 0.14.5

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 CHANGED
@@ -45,11 +45,13 @@ Every built-in target is scoped by `--installation-type <type>`; built-ins curre
45
45
  for project/workspace installs and `user` for documented user-level installs. If a package can be
46
46
  installed in more than one type, agentwheel requires `--installation-type` instead of guessing.
47
47
 
48
- - **OpenClaw** — workspace `skills/`, user `~/.openclaw/skills`
49
- - **Claude Code** — `CLAUDE.md`, `.claude/`, and user `~/.claude/`
50
- - **Codex CLI** — `AGENTS.md`, `.agents/skills`, `.codex/`, and user equivalents
48
+ - **OpenClaw** — workspace `skills/`, local plugin directories; user `~/.openclaw/skills`,
49
+ `~/.openclaw/workspace/AGENTS.md`, and `~/.openclaw/openclaw.json`
50
+ - **Claude Code** — `CLAUDE.md`, `.claude/`, `.mcp.json`, and user `~/.claude/`
51
+ - **Codex CLI** — `AGENTS.md`, `.agents/skills`, `plugins/`, `.codex/`, and user equivalents
51
52
  - **GitHub Copilot CLI** — `.github/`, user `~/.copilot/`, and documented `.agents` skill alternatives
52
- - **Hermes** — local instructions via `AGENTS.md`; skills are user-only at `~/.hermes/skills`
53
+ - **Hermes** — local `AGENTS.md`; user `~/.hermes/SOUL.md`, `~/.hermes/skills`,
54
+ `~/.hermes/plugins`, and `~/.hermes/config.yaml`
53
55
  - **Bring your own** — JSONC config adapters with `--adapter-config`, or programmatic adapters with `--adapter-module`
54
56
 
55
57
  Supported resource types include instructions, rules, skills, commands, subagents, MCP, hooks,
@@ -57,10 +59,10 @@ settings, plugins, and fragments. Runtime compatibility is per artifact and per
57
59
  see [`docs/design/artifact-harness-compatibility.md`](docs/design/artifact-harness-compatibility.md).
58
60
  Fragments are Agentwheel composition inputs, not runtime file-drop targets.
59
61
 
60
- > `rules` is an OpenPack artifact kind, not a portable runtime concept. Codex rules are command
61
- > execution policy, Claude rules are behavioral/path-scoped instructions, and Copilot rule-like
62
- > installs map to path-specific custom instructions. Unsupported rule targets require an explicit
63
- > custom adapter instead of an inferred folder.
62
+ > `rules` is an OpenPack artifact kind, not a portable runtime concept. Claude rules are
63
+ > behavioral/path-scoped instructions, Copilot rule-like installs map to custom instructions, and
64
+ > Codex `.codex/rules` command policy is intentionally outside the built-in behavioral `rules`
65
+ > target. Unsupported rule targets require an explicit custom adapter instead of an inferred folder.
64
66
 
65
67
  ## Core Commands
66
68
 
@@ -74,6 +76,7 @@ Fragments are Agentwheel composition inputs, not runtime file-drop targets.
74
76
  | `agentwheel uninstall <name-or-source>` | Remove a configured package from runtimes and config. |
75
77
  | `agentwheel uninstall <name> --keep-files` | Remove from config/manifest while leaving runtime files unmanaged. |
76
78
  | `agentwheel status` | Show configured packages, manifest/lock presence, and install state. Use `--profile <name>` for profile-managed fleets; `status --all` uses profile `all` when present. |
79
+ | `agentwheel doctor` | Check runtime setup and suggest the explicit companion skill install command when it is missing. |
77
80
 
78
81
  Mental model: **`install` = make what is declared true. `update` = move tracking declarations forward,
79
82
  then make them true.**
@@ -111,6 +114,24 @@ agentwheel checks npm for newer versions at most once every 24 hours and prints
111
114
  stderr warning when an update is available. Disable it with `--no-update-check` or
112
115
  `AGENTWHEEL_NO_UPDATE_CHECK=1`.
113
116
 
117
+ ## Companion Skill Doctor
118
+
119
+ Agentwheel ships its own companion skill in `github:NestDevLab/agentwheel` as `skills/agentwheel`.
120
+ Installing it is optional, but strongly recommended if you want to get the most out of Agentwheel:
121
+ the skill keeps Agentwheel commands, setup guidance, safety rules, and operational patterns available
122
+ inside your agent runtime instead of forcing you to leave the flow and look them up elsewhere.
123
+
124
+ The CLI never installs the companion skill silently into runtime folders. Use `doctor` to check the
125
+ selected runtime and print the exact preview and install commands when the skill is missing:
126
+
127
+ ```bash
128
+ agentwheel doctor --adapter copilot --user
129
+ agentwheel install github:NestDevLab/agentwheel --adapter copilot --user --skill agentwheel --dry-run
130
+ agentwheel install github:NestDevLab/agentwheel --adapter copilot --user --skill agentwheel
131
+ ```
132
+
133
+ Run the dry-run first when you want to inspect the target path and conflict status before writing.
134
+
114
135
  ## Runtime Targeting
115
136
 
116
137
  Normal use does not need `--target-root`. Run agentwheel inside a runtime folder and it detects the
@@ -404,11 +425,11 @@ Built-in runtime targets:
404
425
 
405
426
  | Runtime | Native supported targets |
406
427
  |---|---|
407
- | **OpenClaw** | `local: skills/`; `user: ~/.openclaw/skills`; plugins require runtime-specific config |
408
- | **Claude Code** | `local: CLAUDE.md, .claude/skills, .claude/rules, .claude/commands, .claude/agents, .mcp.json, .claude/settings.json`; `user: ~/.claude/...` except project MCP; rules are behavioral/path-scoped |
409
- | **Codex CLI** | `local: AGENTS.md, .agents/skills, .codex/rules, .codex/agents, .codex/config.toml, .codex/hooks.json`; `user: ~/.agents/skills, ~/.codex/...`; rules are command execution policy; subagents are TOML custom agents |
410
- | **Hermes** | `local: AGENTS.md`; `user: ~/.hermes/skills`; rules require explicit adapter config |
411
- | **GitHub Copilot CLI** | `local: .github/copilot-instructions.md, .github/instructions, .github/prompts, .github/skills, .github/agents, .github/mcp.json, .github/hooks`; `user: ~/.copilot/copilot-instructions.md, ~/.copilot/instructions, ~/.copilot/skills, ~/.copilot/agents, ~/.copilot/mcp-config.json, ~/.copilot/hooks`; rule-like artifacts map to instructions |
428
+ | **OpenClaw** | `local: skills/, .openclaw/plugins/`; `user: ~/.openclaw/workspace/AGENTS.md, ~/.openclaw/skills, ~/.openclaw/openclaw.json`; no built-in `rules` target |
429
+ | **Claude Code** | `local: CLAUDE.md, .claude/skills, .claude/rules, .claude/commands, .claude/agents, .claude/plugins, .mcp.json, .claude/settings.json`; `user: ~/.claude/...` except project MCP; rules are behavioral/path-scoped |
430
+ | **Codex CLI** | `local: AGENTS.md, .agents/skills, plugins/, .codex/agents, .codex/config.toml, .codex/hooks.json`; `user: ~/.codex/AGENTS.md, ~/.agents/skills, ~/.codex/plugins, ~/.codex/agents, ~/.codex/config.toml, ~/.codex/hooks.json`; no built-in `rules` target; generic settings are planned, not implemented |
431
+ | **Hermes** | `local: AGENTS.md`; `user: ~/.hermes/SOUL.md, ~/.hermes/skills, ~/.hermes/plugins, ~/.hermes/config.yaml`; rules require explicit adapter config |
432
+ | **GitHub Copilot CLI** | `local: .github/copilot-instructions.md, .github/instructions, .github/prompts, .github/skills, .github/plugins, .github/agents, .github/mcp.json, .github/hooks, .github/settings.json`; `user: ~/.copilot/copilot-instructions.md, ~/.copilot/instructions, ~/.copilot/skills, ~/.copilot/plugins, ~/.copilot/agents, ~/.copilot/mcp-config.json, ~/.copilot/hooks, ~/.copilot/settings.json`; rule-like artifacts map to instructions |
412
433
 
413
434
  ## Docs
414
435