|
1 | | -# aima-openclaw |
| 1 | +# AIMA Doctor for OpenClaw |
2 | 2 |
|
3 | | -Standalone OpenClaw distribution repo for AIMA Doctor. |
| 3 | +**One-command diagnosis and repair when your OpenClaw agent is stuck.** |
4 | 4 |
|
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. |
6 | 6 |
|
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 |
12 | 8 |
|
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): |
17 | 10 |
|
18 | | -## Supported flow |
| 11 | +```bash |
| 12 | +clawhub install aima-doctor |
| 13 | +``` |
19 | 14 |
|
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**: |
21 | 16 |
|
22 | | -Supported user commands: |
| 17 | +```bash |
| 18 | +openclaw plugins install ./aima-doctor-plugin.zip |
| 19 | +openclaw plugins enable aima-doctor |
| 20 | +``` |
23 | 21 |
|
24 | | -- `/aima <symptom>` |
25 | | -- `/aima status` |
26 | | -- `/aima cancel` |
| 22 | +## Usage |
27 | 23 |
|
28 | | -## Build a release |
| 24 | +In any OpenClaw conversation: |
29 | 25 |
|
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 |
32 | 30 | ``` |
33 | 31 |
|
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>`. |
41 | 33 |
|
42 | | -## Versioning |
| 34 | +## What's in this repo |
43 | 35 |
|
44 | | -This repo intentionally tracks two version surfaces: |
| 36 | +This repository contains the OpenClaw-facing distribution of AIMA Doctor: |
45 | 37 |
|
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 | |
49 | 45 |
|
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. |
52 | 47 |
|
53 | | -## Install the native plugin |
| 48 | +## Build a release |
54 | 49 |
|
55 | 50 | ```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 |
58 | 52 | ``` |
59 | 53 |
|
| 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 | + |
60 | 62 | ## Publish to ClawHub |
61 | 63 |
|
62 | 64 | ```bash |
63 | 65 | cd dist/1.2.1/clawhub-skill |
64 | 66 | clawhub publish ./aima-doctor --slug aima-doctor --name "AIMA Doctor" --version 1.2.1 |
65 | 67 | ``` |
66 | 68 |
|
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 |
68 | 77 |
|
69 | | -## Runtime defaults |
| 78 | +## Compatibility |
70 | 79 |
|
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 |
74 | 84 |
|
75 | 85 | ## License |
76 | 86 |
|
|
0 commit comments