Skip to content

Commit 6cfed19

Browse files
guanjiaweiclaude
andcommitted
docs: rewrite for ClawHub discoverability and user-facing clarity
- ClawHub skill README: replace packaging notes with product page (problem statement, quick start, commands table, compatibility) - SKILL.md: rewrite description for search, add tags in metadata - Root README: lead with install/usage, add ClawHub as primary path - Plugin README: add value prop tagline, scannable commands table - releasing.md: add copy-paste GitHub Release note template - Rebuild dist with updated docs Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 466a94f commit 6cfed19

12 files changed

Lines changed: 235 additions & 125 deletions

File tree

README.md

Lines changed: 53 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,86 @@
1-
# aima-openclaw
1+
# AIMA Doctor for OpenClaw
22

3-
Standalone OpenClaw distribution repo for AIMA Doctor.
3+
**One-command diagnosis and repair when your OpenClaw agent is stuck.**
44

5-
This repository contains the OpenClaw-facing parts of AIMA Doctor only:
5+
AIMA Doctor is an OpenClaw plugin that gives you a deterministic rescue path — diagnose process health, fix config breakage, recover device registration, and run guided repairs driven by the AIMA platform.
66

7-
- `plugin-package/aima-doctor/`: native OpenClaw plugin source
8-
- `clawhub-skill/aima-doctor/`: ClawHub-publishable compatibility skill
9-
- `runtime/`: standalone helper runtime for manual/runtime-only installs
10-
- `scripts/build-release.sh`: reproducible release packager
11-
- `dist/<version>/`: generated release artifacts
7+
## Install
128

13-
The AIMA platform backend, `/doctor/*.zip` distribution endpoints, invite-code
14-
policy, and end-to-end platform tests remain in the main
15-
`Approaching-AI/aima-service-new` repository. This repo is the public
16-
OpenClaw-facing package source.
9+
**From ClawHub** (recommended):
1710

18-
## Supported flow
11+
```bash
12+
clawhub install aima-doctor
13+
```
1914

20-
`/aima` is a deterministic rescue entrypoint for OpenClaw when the normal agent path is degraded but the gateway is still alive and able to receive messages.
15+
**From a release zip**:
2116

22-
Supported user commands:
17+
```bash
18+
openclaw plugins install ./aima-doctor-plugin.zip
19+
openclaw plugins enable aima-doctor
20+
```
2321

24-
- `/aima <symptom>`
25-
- `/aima status`
26-
- `/aima cancel`
22+
## Usage
2723

28-
## Build a release
24+
In any OpenClaw conversation:
2925

30-
```bash
31-
bash scripts/build-release.sh
26+
```
27+
/aima my agent keeps failing to install the package
28+
/aima status
29+
/aima cancel
3230
```
3331

34-
That command generates:
35-
36-
- `dist/1.2.1/aima-doctor-plugin.zip`
37-
- `dist/1.2.1/aima-doctor-runtime.zip`
38-
- `dist/1.2.1/aima-doctor-skill.zip`
39-
- `dist/1.2.1/PUBLISH.md`
40-
- `dist/1.2.1/SHA256SUMS.txt`
32+
When AIMA Doctor asks a follow-up question, reply with `/aima <your answer>`.
4133

42-
## Versioning
34+
## What's in this repo
4335

44-
This repo intentionally tracks two version surfaces:
36+
This repository contains the OpenClaw-facing distribution of AIMA Doctor:
4537

46-
- Git tags such as `v0.1`: public repo milestones
47-
- Bundle version in `VERSION` such as `1.2.1`: the packaged AIMA Doctor bundle
48-
version used by the plugin, runtime, and ClawHub skill
38+
| Directory | Purpose |
39+
|-----------|---------|
40+
| `plugin-package/aima-doctor/` | Native OpenClaw plugin source (primary artifact) |
41+
| `clawhub-skill/aima-doctor/` | ClawHub-publishable skill bundle |
42+
| `runtime/` | Standalone helper runtime for manual installs |
43+
| `scripts/build-release.sh` | Reproducible release packager |
44+
| `dist/<version>/` | Generated release artifacts |
4945

50-
That means the GitHub release can be `v0.1` while the shipped OpenClaw package
51-
version is still `1.2.1`.
46+
The AIMA platform backend, distribution endpoints, and end-to-end platform tests live in the main [aima-service-new](https://github.com/Approaching-AI/aima-service-new) repository.
5247

53-
## Install the native plugin
48+
## Build a release
5449

5550
```bash
56-
openclaw plugins install ./dist/1.2.1/aima-doctor-plugin.zip
57-
openclaw plugins enable aima-doctor
51+
bash scripts/build-release.sh
5852
```
5953

54+
Outputs under `dist/<version>/`:
55+
56+
- `aima-doctor-plugin.zip` — primary install artifact
57+
- `aima-doctor-runtime.zip` — standalone helper runtime
58+
- `aima-doctor-skill.zip` — ClawHub compatibility skill
59+
- `SHA256SUMS.txt` — integrity checksums
60+
- `PUBLISH.md` — release notes
61+
6062
## Publish to ClawHub
6163

6264
```bash
6365
cd dist/1.2.1/clawhub-skill
6466
clawhub publish ./aima-doctor --slug aima-doctor --name "AIMA Doctor" --version 1.2.1
6567
```
6668

67-
For a full release checklist, see `docs/releasing.md`.
69+
For the full release checklist, see [docs/releasing.md](docs/releasing.md).
70+
71+
## Versioning
72+
73+
This repo tracks two version surfaces:
74+
75+
- **Git tags** (e.g., `v0.1`): public repo milestones
76+
- **Bundle version** in `VERSION` (e.g., `1.2.1`): the packaged AIMA Doctor version used by the plugin, runtime, and ClawHub skill
6877

69-
## Runtime defaults
78+
## Compatibility
7079

71-
- Homepage: `https://aimaservice.ai/doctor`
72-
- Default platform API: `https://aimaservice.ai/platform/api/v1`
73-
- Native plugin target: OpenClaw `2026.3.22+`
80+
- **OS**: macOS, Linux, Windows
81+
- **OpenClaw**: 2026.3.22+
82+
- **Default platform API**: https://aimaservice.ai/platform/api/v1
83+
- **Homepage**: https://aimaservice.ai/doctor
7484

7585
## License
7686

Lines changed: 45 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,54 @@
1-
# AIMA Doctor Skill Pack
1+
# AIMA Doctor
22

3-
This folder is a ClawHub-publishable OpenClaw skill bundle for AIMA Doctor.
3+
**One-command diagnosis and repair for OpenClaw.**
44

5-
## What this contains
5+
When your OpenClaw agent is stuck, confused, or unable to complete a task, AIMA Doctor gives you a deterministic rescue path — no guessing, no manual debugging.
66

7-
- `SKILL.md`: the OpenClaw skill entrypoint
8-
- `README.md`: packaging notes
7+
## Quick Start
98

10-
The helper runtime is distributed separately from:
9+
Install from ClawHub:
1110

12-
- `https://aimaservice.ai/doctor/runtime.zip`
11+
```bash
12+
clawhub install aima-doctor
13+
```
14+
15+
Then in any OpenClaw conversation:
16+
17+
```
18+
/aima my agent keeps failing to install the package
19+
```
1320

14-
## Local install
21+
AIMA Doctor will diagnose the issue, walk you through any needed fixes, and report back with clear results.
1522

16-
1. Copy this folder under `<workspace>/skills/` or `~/.openclaw/skills/`.
17-
2. Extract the helper runtime into `~/.openclaw/tools/aima-doctor/`.
18-
3. Start a new OpenClaw session or restart the gateway.
23+
## Commands
1924

20-
## Publish to ClawHub
25+
| Command | What it does |
26+
|---------|-------------|
27+
| `/aima <symptom>` | Start a diagnosis with a description of the problem |
28+
| `/aima status` | Check the progress of a running diagnosis |
29+
| `/aima cancel` | Cancel the current diagnosis |
2130

22-
```bash
23-
clawhub publish ./aima-doctor --slug aima-doctor --name "AIMA Doctor" --version 1.2.1
24-
```
31+
When AIMA Doctor asks a follow-up question, reply with `/aima <your answer>`.
32+
33+
## What it can fix
34+
35+
- OpenClaw process health (hung, crashed, or unresponsive agents)
36+
- Configuration breakage (corrupted settings, missing config files)
37+
- AIMA device registration and token recovery
38+
- Guided local repair driven by AIMA platform diagnostics
39+
40+
## How it works
41+
42+
AIMA Doctor ships a packaged helper runtime that runs locally on your machine. It connects to the AIMA platform API to fetch diagnostics, then executes deterministic repair steps. No remote shell commands, no opaque scripts — everything runs from a versioned, auditable helper.
43+
44+
## Compatibility
45+
46+
- **OS**: macOS, Linux, Windows
47+
- **OpenClaw**: 2026.3.22+
48+
- **Runtime**: downloaded automatically on first use from `https://aimaservice.ai/doctor`
49+
50+
## Links
51+
52+
- Homepage: https://aimaservice.ai/doctor
53+
- Source: https://github.com/Approaching-AI/aima-openclaw
54+
- License: Apache-2.0

clawhub-skill/aima-doctor/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
name: aima
3-
description: Deterministic fallback diagnosis and repair for OpenClaw when the normal agent path is degraded.
3+
description: Diagnose and repair OpenClaw when your agent is stuck, confused, or failing. One-command rescue for process health, config breakage, and device registration.
44
user-invocable: true
55
homepage: https://aimaservice.ai/doctor
6-
metadata: {"openclaw":{"homepage":"https://aimaservice.ai/doctor","skillKey":"aima","os":["darwin","linux","win32"],"install":[{"id":"aima-doctor-runtime","kind":"download","url":"https://aimaservice.ai/doctor/runtime.zip","archive":"zip","extract":true,"targetDir":"~/.openclaw/tools/aima-doctor"}]}}
6+
metadata: {"openclaw":{"homepage":"https://aimaservice.ai/doctor","skillKey":"aima","tags":["diagnosis","repair","troubleshooting","health","recovery"],"os":["darwin","linux","win32"],"install":[{"id":"aima-doctor-runtime","kind":"download","url":"https://aimaservice.ai/doctor/runtime.zip","archive":"zip","extract":true,"targetDir":"~/.openclaw/tools/aima-doctor"}]}}
77
---
88

99
# AIMA Doctor
1010

11-
Use this skill when OpenClaw needs diagnosis or repair and the normal agent flow is degraded, confused, or stuck.
11+
Use this skill when your OpenClaw agent is stuck, confused, or failing — it provides a deterministic rescue path to diagnose and repair the issue.
1212

1313
## Runtime contract
1414

dist/1.2.1/SHA256SUMS.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
2536e2f2353a6f025b8553bf6b5d7eedcdb7d51a7e64efe99f77fff020dc7c4f aima-doctor-plugin.zip
2-
c16a581b34f1f63c1f427f3cc42110a3b828d02951221437135f4a11d915d6f9 aima-doctor-runtime.zip
3-
8b5f63d1d1eee4467a5ca776bef4f284fa68d50f8056dfd1c42eac0b6c946ef3 aima-doctor-skill.zip
1+
72e86df73af8625f0d47b1a64ba95959e07ce78f9970a248e6e89cb93e12f66f aima-doctor-plugin.zip
2+
067a47eee9210956a24fc760573db93b26d4fa6cc08c4f43bb23c39567a3a180 aima-doctor-runtime.zip
3+
a0b08ee3aedc93515945ae4e34df2713b8d519f08990eb7e9b26ec9ec9b65042 aima-doctor-skill.zip

dist/1.2.1/aima-doctor-plugin.zip

68 Bytes
Binary file not shown.

dist/1.2.1/aima-doctor-runtime.zip

0 Bytes
Binary file not shown.

dist/1.2.1/aima-doctor-skill.zip

586 Bytes
Binary file not shown.
Lines changed: 45 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,54 @@
1-
# AIMA Doctor Skill Pack
1+
# AIMA Doctor
22

3-
This folder is a ClawHub-publishable OpenClaw skill bundle for AIMA Doctor.
3+
**One-command diagnosis and repair for OpenClaw.**
44

5-
## What this contains
5+
When your OpenClaw agent is stuck, confused, or unable to complete a task, AIMA Doctor gives you a deterministic rescue path — no guessing, no manual debugging.
66

7-
- `SKILL.md`: the OpenClaw skill entrypoint
8-
- `README.md`: packaging notes
7+
## Quick Start
98

10-
The helper runtime is distributed separately from:
9+
Install from ClawHub:
1110

12-
- `https://aimaservice.ai/doctor/runtime.zip`
11+
```bash
12+
clawhub install aima-doctor
13+
```
14+
15+
Then in any OpenClaw conversation:
16+
17+
```
18+
/aima my agent keeps failing to install the package
19+
```
1320

14-
## Local install
21+
AIMA Doctor will diagnose the issue, walk you through any needed fixes, and report back with clear results.
1522

16-
1. Copy this folder under `<workspace>/skills/` or `~/.openclaw/skills/`.
17-
2. Extract the helper runtime into `~/.openclaw/tools/aima-doctor/`.
18-
3. Start a new OpenClaw session or restart the gateway.
23+
## Commands
1924

20-
## Publish to ClawHub
25+
| Command | What it does |
26+
|---------|-------------|
27+
| `/aima <symptom>` | Start a diagnosis with a description of the problem |
28+
| `/aima status` | Check the progress of a running diagnosis |
29+
| `/aima cancel` | Cancel the current diagnosis |
2130

22-
```bash
23-
clawhub publish ./aima-doctor --slug aima-doctor --name "AIMA Doctor" --version 1.2.1
24-
```
31+
When AIMA Doctor asks a follow-up question, reply with `/aima <your answer>`.
32+
33+
## What it can fix
34+
35+
- OpenClaw process health (hung, crashed, or unresponsive agents)
36+
- Configuration breakage (corrupted settings, missing config files)
37+
- AIMA device registration and token recovery
38+
- Guided local repair driven by AIMA platform diagnostics
39+
40+
## How it works
41+
42+
AIMA Doctor ships a packaged helper runtime that runs locally on your machine. It connects to the AIMA platform API to fetch diagnostics, then executes deterministic repair steps. No remote shell commands, no opaque scripts — everything runs from a versioned, auditable helper.
43+
44+
## Compatibility
45+
46+
- **OS**: macOS, Linux, Windows
47+
- **OpenClaw**: 2026.3.22+
48+
- **Runtime**: downloaded automatically on first use from `https://aimaservice.ai/doctor`
49+
50+
## Links
51+
52+
- Homepage: https://aimaservice.ai/doctor
53+
- Source: https://github.com/Approaching-AI/aima-openclaw
54+
- License: Apache-2.0

dist/1.2.1/clawhub-skill/aima-doctor/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
name: aima
3-
description: Deterministic fallback diagnosis and repair for OpenClaw when the normal agent path is degraded.
3+
description: Diagnose and repair OpenClaw when your agent is stuck, confused, or failing. One-command rescue for process health, config breakage, and device registration.
44
user-invocable: true
55
homepage: https://aimaservice.ai/doctor
6-
metadata: {"openclaw":{"homepage":"https://aimaservice.ai/doctor","skillKey":"aima","os":["darwin","linux","win32"],"install":[{"id":"aima-doctor-runtime","kind":"download","url":"https://aimaservice.ai/doctor/runtime.zip","archive":"zip","extract":true,"targetDir":"~/.openclaw/tools/aima-doctor"}]}}
6+
metadata: {"openclaw":{"homepage":"https://aimaservice.ai/doctor","skillKey":"aima","tags":["diagnosis","repair","troubleshooting","health","recovery"],"os":["darwin","linux","win32"],"install":[{"id":"aima-doctor-runtime","kind":"download","url":"https://aimaservice.ai/doctor/runtime.zip","archive":"zip","extract":true,"targetDir":"~/.openclaw/tools/aima-doctor"}]}}
77
---
88

99
# AIMA Doctor
1010

11-
Use this skill when OpenClaw needs diagnosis or repair and the normal agent flow is degraded, confused, or stuck.
11+
Use this skill when your OpenClaw agent is stuck, confused, or failing — it provides a deterministic rescue path to diagnose and repair the issue.
1212

1313
## Runtime contract
1414

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
11
# AIMA Doctor Plugin
22

3-
This archive is the primary OpenClaw `2026.3.22+` install artifact for AIMA Doctor.
4-
5-
## What this contains
6-
7-
- `openclaw.plugin.json`: native OpenClaw plugin manifest
8-
- `index.js`: gateway plugin entrypoint
9-
- `skills/aima-doctor/SKILL.md`: bundled reference skill
10-
- `runtime/run.sh`: packaged doctor helper for macOS/Linux
11-
- `runtime/run.ps1`: packaged doctor helper for Windows
12-
- `runtime/config.json`: default AIMA platform URL
3+
**One-command diagnosis and repair for OpenClaw.** This is the primary native plugin for OpenClaw 2026.3.22+.
134

145
## Install
156

@@ -18,17 +9,28 @@ openclaw plugins install ./aima-doctor-plugin.zip
189
openclaw plugins enable aima-doctor
1910
```
2011

21-
Then use these IM commands:
12+
## Commands
13+
14+
| Command | What it does |
15+
|---------|-------------|
16+
| `/aima <symptom>` | Start a diagnosis with a description of the problem |
17+
| `/aima status` | Check progress of a running diagnosis |
18+
| `/aima cancel` | Cancel the current diagnosis |
19+
20+
When the helper asks a follow-up question, reply with `/aima <your answer>`.
21+
22+
Legacy `/askforhelp*` and `/doctor*` aliases remain available for compatibility.
2223

23-
- `/aima [symptom]`
24-
- `/aima status`
25-
- `/aima cancel`
24+
## What's inside
2625

27-
When the helper asks a question, answer with `/aima <your reply>`.
26+
- `openclaw.plugin.json` — native OpenClaw plugin manifest
27+
- `index.js` — gateway plugin entrypoint
28+
- `skills/aima-doctor/SKILL.md` — bundled reference skill
29+
- `runtime/run.sh` — helper for macOS/Linux
30+
- `runtime/run.ps1` — helper for Windows
31+
- `runtime/config.json` — default AIMA platform URL
2832

2933
## Notes
3034

31-
- The plugin package owns execution.
32-
- The bundled skill is for discovery/documentation and does not replace the native `/aima` command family.
33-
- Legacy `/askforhelp*` and `/doctor*` aliases remain available for compatibility.
34-
- Homepage: `https://aimaservice.ai/doctor`
35+
- The plugin package owns execution; the bundled skill is for discovery/documentation only.
36+
- Homepage: https://aimaservice.ai/doctor

0 commit comments

Comments
 (0)