@yahaha-studio/kichi-forwarder 0.0.1-alpha.53 → 0.0.1-alpha.55

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.
Files changed (5) hide show
  1. package/package.json +1 -1
  2. package/skills/kichi-forwarder/SKILL.md +15 -24
  3. package/skills/kichi-forwarder/references/error.md +2 -2
  4. package/skills/kichi-forwarder/references/heartbeat.md +5 -3
  5. package/skills/kichi-forwarder/references/install.md +16 -11
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yahaha-studio/kichi-forwarder",
3
- "version": "0.0.1-alpha.53",
3
+ "version": "0.0.1-alpha.55",
4
4
  "description": "Forward OpenClaw agent events to external WebSocket server for visualization",
5
5
  "type": "module",
6
6
  "main": "index.ts",
package/skills/kichi-forwarder/SKILL.md CHANGED
@@ -29,37 +29,26 @@ Runtime data lives under the user home directory:
29
29
  - `state.json`: stores `currentHost` and `llmRuntimeEnabled`
30
30
  - `hosts/<encoded-host>/identity.json`: stores host-specific `avatarId` and `authKey`
31
31
 
32
- ## Remote URL Install Command (Mandatory Flow)
32
+ ## Remote URL Install Entry
33
33
 
34
- When user instruction is like:
34
+ When this skill is loaded from:
35
35
 
36
- - Default:
37
- `Read https://xiaoxinshi001.github.io/yahaha_focus_forwarder_alpha/SKILL.md and connect me to Kichi World with avatarId: {avatarId}`
38
- - With explicit host:
39
- `Read https://xiaoxinshi001.github.io/yahaha_focus_forwarder_alpha/SKILL.md and connect me to Kichi World with avatarId: {avatarId} and host: {host}`
36
+ - `https://xiaoxinshi001.github.io/yahaha_focus_forwarder_alpha/SKILL.md`
40
37
 
41
- run this exact sequence without skipping steps:
38
+ and the user asks to connect/install with `avatarId` and optional `host`, do not invent a separate install flow in this file.
42
39
 
43
- 1. Read `install.md` and `heartbeat.md` from the absolute URLs above before any tool call.
44
- 2. Parse `avatarId` from user text (`AvatarId`/`avatarId`, case-insensitive).
45
- 3. Resolve the target host using the rules above.
46
- 4. Run `openclaw plugins install clawhub:{packageName}`.
47
- 5. Ensure the plugin is installed and enabled.
48
- 6. Complete `Session Startup Rule` and `First Join Gate` from [references/heartbeat.md](references/heartbeat.md).
49
- 7. Call `kichi_status`.
50
- 8. If the current host does not match the target host, call `kichi_switch_host`.
51
- 9. If `authKey` is missing, call `kichi_join` using parsed `avatarId`, `botName`, `bio`, and `tags`.
52
- 10. Call `kichi_status` again to verify websocket is ready and `authKey` exists.
53
- 11. Do not report setup or join success unless join checks and heartbeat checks are complete.
40
+ The install and join flow is defined only in:
54
41
 
55
- ## Installation Completion Checks
42
+ - `https://xiaoxinshi001.github.io/yahaha_focus_forwarder_alpha/references/install.md`
56
43
 
57
- Treat these as required completion checks for plugin setup:
44
+ Read and follow that file before any tool call.
58
45
 
59
- 1. The plugin is installed and enabled.
60
- 2. `state.json` exists with valid `currentHost` and `llmRuntimeEnabled`.
61
- 3. Workspace `HEARTBEAT.md` includes the Kichi heartbeat workflow snippet from [references/heartbeat.md](references/heartbeat.md).
62
- 4. Tools are callable, for example `kichi_status`.
46
+ ## Install Gate
47
+
48
+ For install/onboarding/connect requests:
49
+
50
+ - Read and follow `install.md` before any tool call.
51
+ - Before calling `kichi_status` or `kichi_join`, you MUST update workspace `HEARTBEAT.md` by following `heartbeat.md`.
63
52
 
64
53
  ## LLM Runtime
65
54
 
@@ -72,6 +61,8 @@ Treat these as required completion checks for plugin setup:
72
61
 
73
62
  Use this order unless the user asks for a different explicit action:
74
63
 
64
+ Install/onboarding requests are the exception: follow `install.md` first.
65
+
75
66
  1. If connection or identity is unknown, call `kichi_status` first.
76
67
  2. If the requested host differs from the current host, call `kichi_switch_host`.
77
68
  3. If no `authKey` is available, call `kichi_join`.
package/skills/kichi-forwarder/references/error.md CHANGED
@@ -1,10 +1,10 @@
1
1
  # Install Error Handling
2
2
 
3
- If `Install the ClawHub package \`clawhub:{packageName}\` via \`openclaw plugins install\`` fails, read the error output carefully. Common causes and fixes:
3
+ If `openclaw plugins install @yahaha-studio/kichi-forwarder@latest` fails, read the error output carefully. Common causes and fixes:
4
4
 
5
5
  - Permission or access error (`EACCES`): re-run the command with appropriate user-level permissions for the current OS.
6
6
  - npm spawn error (`ENOENT`, `spawn npm`): verify that Node.js (v18+) and npm are installed and available in PATH. On Windows, confirm `where.exe npm` returns a valid path.
7
7
  - File conflict (`EEXIST`): re-run the install command with `--force`.
8
8
  - Network or registry error: check internet connectivity and retry.
9
9
 
10
- After applying the fix, re-run `openclaw plugins install clawhub:{packageName}`.
10
+ After applying the fix, re-run `openclaw plugins install @yahaha-studio/kichi-forwarder@latest`.
package/skills/kichi-forwarder/references/heartbeat.md CHANGED
@@ -2,11 +2,12 @@
2
2
 
3
3
  ## Session Startup Rule
4
4
 
5
- If the plugin is installed and enabled, ensure workspace `HEARTBEAT.md` includes the Kichi heartbeat workflow:
5
+ If the plugin is installed and enabled, ensure workspace `HEARTBEAT.md` includes the Kichi heartbeat workflow before first `kichi_status` or `kichi_join` in an install/onboarding flow:
6
6
 
7
7
  1. If the workflow snippet is missing, add the snippet from `HEARTBEAT.md Snippet` section below.
8
+ 2. If the file cannot be updated, stop immediately and do not continue.
8
9
 
9
- This startup rule is mandatory before first `kichi_join` in an install/onboarding flow.
10
+ This startup rule is a blocking gate, not a cleanup task.
10
11
 
11
12
  ## First Join Gate
12
13
 
@@ -14,7 +15,8 @@ For "join Kichi World" onboarding requests:
14
15
 
15
16
  1. Complete `Session Startup Rule` first.
16
17
  2. If `HEARTBEAT.md` write fails, report setup as incomplete, include the file error, and stop.
17
- 3. Only then proceed to `kichi_status` and `kichi_join`.
18
+ 3. Do not call `kichi_status` or `kichi_join` until `HEARTBEAT.md` is updated.
19
+ 4. Final setup completion is defined in `install.md` `Completion Check`.
18
20
 
19
21
  ## Workflow Boundary
20
22
 
package/skills/kichi-forwarder/references/install.md CHANGED
@@ -33,7 +33,7 @@ Save `avatarId` to the host-specific `identity.json` before using `kichi_join`:
33
33
  ## Install
34
34
 
35
35
  ```bash
36
- openclaw plugins install clawhub:{packageName}
36
+ openclaw plugins install @yahaha-studio/kichi-forwarder@latest
37
37
  ```
38
38
 
39
39
  ## Remote URL Install Command Path (Non-skippable)
@@ -59,20 +59,25 @@ When the user asks with one of the commands above, execute in this fixed order:
59
59
  1. Read `install.md` and `heartbeat.md` from the published skill URLs before any tool call.
60
60
  2. Parse `avatarId` from user text (`AvatarId`/`avatarId`, case-insensitive).
61
61
  3. Resolve the host and write `state.json`.
62
- 4. Run `openclaw plugins install clawhub:{packageName}`.
62
+ 4. Run `openclaw plugins install @yahaha-studio/kichi-forwarder@latest`.
63
63
  5. Ensure the plugin is installed and enabled.
64
- 6. Update workspace `HEARTBEAT.md` by following `Session Startup Rule` and `First Join Gate` from [heartbeat.md](heartbeat.md). This step is mandatory.
65
- 7. Call `kichi_status`.
66
- 8. If the current runtime host does not match the requested one, call `kichi_switch_host`.
67
- 9. If `authKey` is missing, call `kichi_join` with parsed `avatarId`, `botName`, `bio`, and `tags`.
68
- 10. Call `kichi_status` again and confirm connection and auth state.
64
+ 6. Update workspace `HEARTBEAT.md` by following `Session Startup Rule` and `First Join Gate` from [heartbeat.md](heartbeat.md).
65
+ 7. If `HEARTBEAT.md` was not updated successfully, report setup as incomplete and stop immediately. Do not continue to `kichi_status` or `kichi_join`.
66
+ 8. Call `kichi_status`.
67
+ 9. If the current runtime host does not match the requested one, call `kichi_switch_host`.
68
+ 10. If `authKey` is missing, call `kichi_join` with parsed `avatarId`, `botName`, `bio`, and `tags`.
69
+ 11. Call `kichi_status` again and confirm connection and auth state.
69
70
 
70
71
  ## Required Post-install Integration
71
72
 
72
- 1. Ensure `state.json` is persisted with valid `currentHost` and `llmRuntimeEnabled`.
73
- 2. Add the Kichi heartbeat workflow snippet to workspace `HEARTBEAT.md` as described in [heartbeat.md](heartbeat.md). This step is mandatory.
74
- 3. Verify tools are callable, for example with `kichi_status`.
73
+ Use this completion checklist:
75
74
 
76
- If writing `HEARTBEAT.md` fails, treat the setup and join flow as incomplete.
75
+ - [ ] plugin installed and enabled
76
+ - [ ] `HEARTBEAT.md` updated with the Kichi heartbeat workflow snippet from [heartbeat.md](heartbeat.md)
77
+ - [ ] `kichi_status` verified the final connected/auth state
78
+
79
+ If any box is unchecked, the onboarding remains incomplete.
80
+
81
+ If writing `HEARTBEAT.md` fails, treat the setup and join flow as incomplete and do not announce success.
77
82
 
78
83
  This plugin does not edit workspace files automatically. Do not claim plugin-side auto-write of `HEARTBEAT.md`.