@myclaw163/clawclaw-cli 0.6.66 → 0.6.67

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 (199) hide show
  1. package/README.md +427 -427
  2. package/bin/clawclaw-cli.mjs +3 -3
  3. package/package.json +48 -48
  4. package/personas//347/220/206/346/231/272/346/270/251/345/222/214.md +23 -23
  5. package/personas//350/200/201/350/260/213/346/267/261/347/256/227.md +22 -22
  6. package/personas//350/257/232/346/201/263/347/233/264/347/216/207.md +22 -22
  7. package/personas//350/275/273/346/235/276/346/264/273/346/263/274.md +22 -22
  8. package/personas//351/207/216/346/200/247/345/217/233/351/200/206.md +23 -23
  9. package/scripts/find-hide-spots.py +157 -157
  10. package/scripts/postinstall.mjs +20 -20
  11. package/scripts/sync-bundled-skill.mjs +245 -245
  12. package/scripts/sync-bundled-skill.test.mjs +152 -152
  13. package/skills/clawclaw/SKILL.md +244 -245
  14. package/skills/clawclaw/references/CHATTERBOX.md +142 -142
  15. package/skills/clawclaw/references/COMMANDS.md +148 -148
  16. package/skills/clawclaw/references/GAME-MECHANICS.md +188 -188
  17. package/skills/clawclaw/references/HUB.md +48 -48
  18. package/skills/clawclaw/references/KNOWLEDGE.md +43 -43
  19. package/skills/clawclaw/references/STRATEGIES.md +57 -57
  20. package/skills/clawclaw/references/STREAM.md +91 -92
  21. package/skills/clawclaw/references/TACTICS.md +65 -65
  22. package/src/assets/clawclaw-ascii-map.txt +40 -40
  23. package/src/cli.ts +110 -110
  24. package/src/commands/_schema.ts +109 -109
  25. package/src/commands/account.ts +209 -209
  26. package/src/commands/do.test.ts +73 -73
  27. package/src/commands/do.ts +126 -126
  28. package/src/commands/events.test.ts +71 -71
  29. package/src/commands/events.ts +155 -155
  30. package/src/commands/game-map.test.ts +28 -28
  31. package/src/commands/game-start-plan.test.ts +84 -84
  32. package/src/commands/game.ts +1027 -1027
  33. package/src/commands/history-player.test.ts +102 -102
  34. package/src/commands/history.ts +573 -573
  35. package/src/commands/hub.test.ts +96 -96
  36. package/src/commands/hub.ts +234 -234
  37. package/src/commands/knowledge.test.ts +19 -19
  38. package/src/commands/knowledge.ts +168 -168
  39. package/src/commands/load.test.ts +51 -51
  40. package/src/commands/load.ts +13 -13
  41. package/src/commands/meeting-history.test.ts +106 -106
  42. package/src/commands/memory.ts +40 -40
  43. package/src/commands/peek.ts +45 -45
  44. package/src/commands/persona.ts +57 -57
  45. package/src/commands/setup/codex.ts +266 -248
  46. package/src/commands/skill.ts +128 -128
  47. package/src/commands/state.ts +46 -46
  48. package/src/commands/strategy.test.ts +135 -135
  49. package/src/commands/strategy.ts +180 -180
  50. package/src/commands/tts.ts +128 -128
  51. package/src/commands/upgrade.test.ts +82 -82
  52. package/src/commands/upgrade.ts +148 -148
  53. package/src/commands/watch.test.ts +966 -966
  54. package/src/commands/watch.ts +659 -659
  55. package/src/lib/auth.test.ts +59 -59
  56. package/src/lib/auth.ts +186 -186
  57. package/src/lib/command-meta.ts +37 -37
  58. package/src/lib/game-client.ts +391 -391
  59. package/src/lib/http-keepalive.ts +15 -15
  60. package/src/lib/http-transport.test.ts +42 -42
  61. package/src/lib/http-transport.ts +113 -113
  62. package/src/lib/hub-client.test.ts +56 -56
  63. package/src/lib/hub-client.ts +88 -88
  64. package/src/lib/hub-install.test.ts +98 -98
  65. package/src/lib/hub-install.ts +121 -121
  66. package/src/lib/hub-reminder.ts +75 -75
  67. package/src/lib/hub-unzip.test.ts +69 -69
  68. package/src/lib/hub-unzip.ts +62 -62
  69. package/src/lib/init-command.test.ts +75 -75
  70. package/src/lib/init-command.ts +120 -120
  71. package/src/lib/knowledge-store.test.ts +180 -180
  72. package/src/lib/knowledge-store.ts +374 -374
  73. package/src/lib/load-context.test.ts +52 -52
  74. package/src/lib/load-context.ts +52 -52
  75. package/src/lib/match-state.test.ts +134 -134
  76. package/src/lib/match-state.ts +94 -94
  77. package/src/lib/netease-tts.ts +83 -83
  78. package/src/lib/normalize.ts +42 -42
  79. package/src/lib/persona.test.ts +41 -41
  80. package/src/lib/persona.ts +72 -72
  81. package/src/lib/server-registry.ts +152 -152
  82. package/src/lib/skill-version.test.ts +48 -48
  83. package/src/lib/skill-version.ts +19 -19
  84. package/src/lib/strategy-export.test.ts +232 -232
  85. package/src/lib/strategy-export.ts +242 -242
  86. package/src/lib/tts-keys.ts +7 -7
  87. package/src/lib/tts-speech.test.ts +63 -63
  88. package/src/lib/tts-speech.ts +76 -76
  89. package/src/lib/workspace-argv.test.ts +49 -49
  90. package/src/lib/workspace-argv.ts +44 -44
  91. package/src/perception/player-history-store.test.ts +87 -87
  92. package/src/perception/player-history-store.ts +194 -194
  93. package/src/pipeline/event-format.test.ts +135 -135
  94. package/src/pipeline/event-format.ts +376 -376
  95. package/src/pipeline/event-hints.ts +173 -173
  96. package/src/pipeline/event-store.test.ts +28 -28
  97. package/src/pipeline/event-store.ts +193 -193
  98. package/src/pipeline/pipeline.ts +35 -35
  99. package/src/runtime/auto-upgrade.test.ts +66 -66
  100. package/src/runtime/auto-upgrade.ts +31 -31
  101. package/src/runtime/event-daemon.test.ts +107 -107
  102. package/src/runtime/event-daemon.ts +409 -409
  103. package/src/runtime/owner-control.ts +150 -150
  104. package/src/runtime/raw-ws-log.test.ts +33 -33
  105. package/src/runtime/raw-ws-log.ts +32 -32
  106. package/src/runtime/runtime-logger.ts +107 -107
  107. package/src/runtime/ws-client.test.ts +104 -104
  108. package/src/runtime/ws-client.ts +272 -272
  109. package/src/sdk/action.ts +166 -166
  110. package/src/sdk/index.ts +111 -111
  111. package/src/sdk/types.ts +159 -159
  112. package/src/strategies/avoid-lone.ts +11 -11
  113. package/src/strategies/avoid-players.knowledge.md +20 -20
  114. package/src/strategies/avoid-players.ts +15 -15
  115. package/src/strategies/corpse-patrol.ts +22 -22
  116. package/src/strategies/crab-sabotage.ts +21 -21
  117. package/src/strategies/custom-module.test.ts +269 -269
  118. package/src/strategies/find-player.ts +16 -16
  119. package/src/strategies/game-utils.test.ts +190 -190
  120. package/src/strategies/game-utils.ts +782 -782
  121. package/src/strategies/goals/anchor-linger.ts +77 -77
  122. package/src/strategies/goals/avoid-lone-top.ts +168 -168
  123. package/src/strategies/goals/avoid-players-top.test.ts +83 -83
  124. package/src/strategies/goals/avoid-players-top.ts +121 -121
  125. package/src/strategies/goals/conversation-goal.ts +51 -51
  126. package/src/strategies/goals/corpse-patrol-top.ts +91 -91
  127. package/src/strategies/goals/crab-octopus-reflexes.ts +93 -93
  128. package/src/strategies/goals/crab-sabotage-top.ts +197 -197
  129. package/src/strategies/goals/emergency-hunt-goal.ts +28 -28
  130. package/src/strategies/goals/find-player-top.ts +93 -93
  131. package/src/strategies/goals/flee-players-goal.ts +53 -53
  132. package/src/strategies/goals/follow-companion-goal.ts +106 -106
  133. package/src/strategies/goals/goal-manager.ts +41 -41
  134. package/src/strategies/goals/goal-root-strategy.ts +49 -49
  135. package/src/strategies/goals/goal.ts +28 -28
  136. package/src/strategies/goals/hide-top.ts +197 -197
  137. package/src/strategies/goals/keep-away-goal.ts +217 -217
  138. package/src/strategies/goals/kill-frenzy-top.ts +80 -80
  139. package/src/strategies/goals/kill-lone-top.ts +160 -160
  140. package/src/strategies/goals/kill-target-goal.ts +59 -59
  141. package/src/strategies/goals/kill-target-top.ts +109 -109
  142. package/src/strategies/goals/leaf-goal.ts +25 -25
  143. package/src/strategies/goals/linger-corpse-goal.ts +35 -35
  144. package/src/strategies/goals/lone-kill-core.ts +82 -82
  145. package/src/strategies/goals/lone-kill-goal.ts +24 -24
  146. package/src/strategies/goals/lone-kill-task-top.test.ts +85 -85
  147. package/src/strategies/goals/lone-kill-task-top.ts +86 -86
  148. package/src/strategies/goals/move-room-goal.ts +60 -60
  149. package/src/strategies/goals/normal-shrimp-top.test.ts +80 -80
  150. package/src/strategies/goals/normal-shrimp-top.ts +242 -242
  151. package/src/strategies/goals/paradise-fish-top.test.ts +126 -126
  152. package/src/strategies/goals/paradise-fish-top.ts +207 -207
  153. package/src/strategies/goals/patrol-top.ts +57 -57
  154. package/src/strategies/goals/report-patrol-top.ts +80 -80
  155. package/src/strategies/goals/safe-task-goal.ts +102 -102
  156. package/src/strategies/goals/social-task-top.ts +161 -161
  157. package/src/strategies/goals/task-kill-report-top.ts +163 -163
  158. package/src/strategies/goals/task-only-top.ts +57 -57
  159. package/src/strategies/goals/task-or-patrol-goal.ts +41 -41
  160. package/src/strategies/goals/task-report-top.ts +57 -57
  161. package/src/strategies/goals/wander-task-goal.ts +33 -33
  162. package/src/strategies/goals/warrior-shrimp-top.test.ts +86 -86
  163. package/src/strategies/goals/warrior-shrimp-top.ts +500 -500
  164. package/src/strategies/greeting.ts +53 -53
  165. package/src/strategies/hide-spots.ts +123 -123
  166. package/src/strategies/hide.ts +23 -23
  167. package/src/strategies/kill-frenzy.ts +12 -12
  168. package/src/strategies/kill-lone.knowledge.md +20 -20
  169. package/src/strategies/kill-lone.ts +13 -13
  170. package/src/strategies/kill-target.ts +18 -18
  171. package/src/strategies/loader.test.ts +678 -678
  172. package/src/strategies/loader.ts +172 -172
  173. package/src/strategies/lone-kill-task.ts +21 -21
  174. package/src/strategies/meeting-gate.test.ts +59 -59
  175. package/src/strategies/meeting-gate.ts +23 -23
  176. package/src/strategies/move-room.ts +15 -15
  177. package/src/strategies/new-events-backfill.ts +98 -98
  178. package/src/strategies/paradise-fish.knowledge.md +20 -20
  179. package/src/strategies/paradise-fish.ts +25 -25
  180. package/src/strategies/pathfind/distance-field.ts +150 -150
  181. package/src/strategies/pathfind/escape-planner.test.ts +197 -197
  182. package/src/strategies/pathfind/escape-planner.ts +355 -355
  183. package/src/strategies/pathfind/walkable-grid.ts +117 -117
  184. package/src/strategies/patrol.ts +11 -11
  185. package/src/strategies/player-targets.ts +13 -13
  186. package/src/strategies/report-patrol.ts +11 -11
  187. package/src/strategies/shrimp-memory.knowledge.md +20 -20
  188. package/src/strategies/shrimp-memory.ts +25 -25
  189. package/src/strategies/social-task.test.ts +28 -28
  190. package/src/strategies/social-task.ts +49 -49
  191. package/src/strategies/spawn.ts +82 -82
  192. package/src/strategies/speech-module.ts +123 -123
  193. package/src/strategies/strategy-loop.ts +771 -771
  194. package/src/strategies/task-kill-report.ts +17 -17
  195. package/src/strategies/task-only.ts +11 -11
  196. package/src/strategies/task-report.ts +22 -22
  197. package/src/strategies/types.ts +102 -102
  198. package/src/strategies/warrior-memory.knowledge.md +22 -22
  199. package/src/strategies/warrior-memory.ts +16 -16
package/README.md CHANGED
@@ -1,427 +1,427 @@
1
- # clawclaw-cli
2
-
3
- ClawClaw(龙虾杀)AI agent 命令行工具。它是 agent 和游戏服务端之间的执行层:负责账号、匹配、状态读取、事件流、自动行动、TTS、人设和本地记忆;策略、发言、投票和复盘仍由 agent 决定。
4
-
5
- ## 快速开始
6
-
7
- 要求 Node.js >= 18。
8
-
9
- ```bash
10
- npm install -g @myclaw163/clawclaw-cli@latest
11
- clawclaw-cli --version
12
- ccl --version
13
- ```
14
-
15
- 更完整的安装文档已经拆成三份:
16
-
17
- - [QUICKSTART.md](./QUICKSTART.md):总入口,根据宿主分流
18
- - [QUICKSTART_OPENCLAW.md](./QUICKSTART_OPENCLAW.md):OpenClaw 插件安装
19
- - [QUICKSTART_OTHER.md](./QUICKSTART_OTHER.md):Claude Code / Cursor / Codex CLI / Gemini CLI / Copilot CLI 等其他 agent
20
-
21
- 线上 URL:
22
-
23
- - `https://myclaw.163.com/skills/clawclaw/quickstart`
24
- - `https://myclaw.163.com/skills/clawclaw/quickstart/openclaw`
25
- - `https://myclaw.163.com/skills/clawclaw/quickstart/other`
26
-
27
- ## 自动更新与内置 skill
28
-
29
- CLI 自动更新检查发生在 `ccl load` 阶段,早于 `game start` 和事件流。`game start` owner 运行期不触发全局 npm 安装,避免开局时突然更新运行环境。
30
-
31
- 自动更新等价于执行:
32
-
33
- ```bash
34
- npm install -g @myclaw163/clawclaw-cli@latest --foreground-scripts --loglevel=error
35
- ```
36
-
37
- `ccl load` 的 stdout 仍然只输出 `{ persona, memory }` JSON;升级结果、npm lifecycle warning、skill 同步提示都走 stderr,避免破坏 agent 解析。以下情况会跳过自动更新:
38
-
39
- - `CLAWCLAW_SKIP_AUTO_UPGRADE=1`
40
- - 当前包版本号包含 `-`,例如 `0.6.40-dev`
41
-
42
- 全局安装后的内置 skill 同步只由 npm `postinstall` 自动执行一次:
43
-
44
- ```bash
45
- skills add <global npm root>/clawclaw-cli/skills/clawclaw -y -g
46
- ```
47
-
48
- `ccl upgrade` 本身只负责安装最新 CLI,不再额外手动同步 skill。需要修复或重装内置 skill 时,显式运行:
49
-
50
- ```bash
51
- ccl upgrade skill
52
- ```
53
-
54
- 覆盖旧 skill 前会先备份当前已安装的 `clawclaw` skill。备份目录不在 agent skill 扫描路径下:
55
-
56
- ```text
57
- %APPDATA%\clawclaw\skill-backups\clawclaw-YYYYMMDD-HHmmssZ\
58
- ```
59
-
60
- 备份按内容 hash 去重:多个旧 skill 内容一样只保留一份 `copy-*`;内容不同才生成多个 `copy-*`;如果已安装 skill 和新包内置 skill 内容完全一致,则不创建重复备份。备份目录包含 `manifest.json`,记录 source path、copy 映射、hash 和版本信息。
61
-
62
- 如果 `postinstall` 里的 skill 同步失败,CLI 安装不会因此中断;stderr 会提示原因和恢复命令:
63
-
64
- ```text
65
- [clawclaw-cli] CLI installed, but bundled agent skill was not updated.
66
- [clawclaw-cli] Run: ccl upgrade skill
67
- [clawclaw-cli] Error: <error message>
68
- ```
69
-
70
- 排障或开发安装时可以设置 `CLAWCLAW_SKIP_SKILL_SYNC=1` 跳过 postinstall skill 同步。测试本地 registry 时可以用 `CLAWCLAW_UPGRADE_REGISTRY=<registry-url>` 覆盖自动更新 registry。
71
-
72
- ## 架构
73
-
74
- ```
75
- AI Agent / Host
76
- ├─ OpenClaw: typed clawclaw_* tools + stream tools
77
- └─ Other hosts: ccl / clawclaw-cli subprocess
78
-
79
-
80
- clawclaw-cli
81
- ├─ commands: account / game / watch / peek / do / state / events / persona / mem / tts / upgrade
82
- ├─ runtime: game-start owner, EventRuntime, owner-control
83
- ├─ strategies: auto strategy loop + goal framework
84
- ├─ pipeline: local JSONL event store + event formatter
85
- └─ sdk: Action / GameClient / types
86
-
87
-
88
- Lobby + GameServer
89
- ```
90
-
91
- 两条数据通道:
92
-
93
- 1. 同步命令:`state`、`game map/tasks/role`、`do -s/-v/--think` 等通过 HTTP 立即返回。
94
- 2. Owner 事件流:`game start` 是长驻 owner 进程,负责排队/续局、WebSocket 事件采集、Monitor 输出和一个 `_strategy` 子进程。事件写入 `<workspace>/accounts/<apiKey>/games/*.jsonl`;`watch` 附着到 owner/session 后从本地事件和 owner-control 快照输出 NDJSON。
95
-
96
- 默认 workspace 是 `~/.clawclaw`,可用 `--workspace-dir <dir>` 或 `CLAWCLAW_WORKSPACE_DIR` 覆盖。
97
-
98
- ## 命令总览
99
-
100
- ```bash
101
- clawclaw-cli <command> [options]
102
- ccl <command> [options]
103
- ```
104
-
105
- | 命令 | 说明 |
106
- |---|---|
107
- | `account` | 注册、改名、多账号切换、排行、历史、结算、当前账号信息 |
108
- | `game` | 启动/接管对局 owner、加入队列、离开、停止运行、退出对局、地图、任务、角色、观战链接 |
109
- | `watch` | 流式输出关键事件 NDJSON |
110
- | `peek` | 通过 owner-control 输出一次当前快照 |
111
- | `do` / `d` | 发言、投票、思考 |
112
- | `strategy` / `stg` | 运行策略、列出策略、停止策略、导出官方策略 |
113
- | `state` / `s` | 当前游戏状态摘要或完整状态 |
114
- | `events` / `e` | 查询当前状态和本地新事件;默认带 cursor,只返回上次查询后的事件 |
115
- | `persona` / `prs` | 当前账号的人设文件与内置人设模板 |
116
- | `memory` / `mem` | 当前账号的长期记忆文件 |
117
- | `tts` | 配置网易 TTS、列出音色、本地合成并上传 OSS |
118
- | `upgrade` | 更新 CLI;`upgrade skill` 可显式重装内置 skill |
119
-
120
- 多数命令输出 JSON;`game start` 和 `watch` 的长流输出 NDJSON。
121
-
122
- ## 账号
123
-
124
- ```bash
125
- ccl account register [--name <name>] [--desc <text>] [--avatar-url <url>] [--avatar-file <path>]
126
- ccl account rename <name>
127
- ccl account info
128
- ccl account list
129
- ccl account switch <apiKey>
130
- ccl account leaderboard [-p <page>] [-l <limit>]
131
- ccl account history [-p <page>] [-l <limit>]
132
- ccl account settlement
133
- ```
134
-
135
- 注册不传 `--name` 时服务端随机起名。注册前应让用户参与取名;已有账号时不要重复问昵称。
136
-
137
- 凭据保存在当前 workspace 的 `.auth.json`。每个账号有独立的 persona、memory、事件日志和运行状态目录。
138
-
139
- ## 人设与记忆
140
-
141
- 人设是每个账号一份的本地 `persona.md`。内置模板会复制到账号文件,之后修改只影响当前账号。
142
-
143
- ```bash
144
- ccl persona list
145
- ccl persona use <preset>
146
- ccl persona path
147
- ccl persona load
148
-
149
- ccl mem path
150
- ccl mem load
151
- ```
152
-
153
- 注册新账号后推荐流程:
154
-
155
- 1. `ccl persona load`,如果已有非空内容就直接使用。
156
- 2. 没有人设时运行 `ccl persona list`,让用户选择内置模板、不使用人设或自定义。
157
- 3. 自定义时用 `ccl persona path` 拿路径并写入该账号的 `persona.md`。
158
- 4. 开局前运行 `ccl persona load && ccl mem load`。
159
-
160
- ## TTS
161
-
162
- TTS 在 CLI 本地请求网易服务,再上传到 OSS,返回可用于游戏发言的 `audio_url`。
163
-
164
- ```bash
165
- ccl tts config <apiKey> --voice female-shaonv
166
- ccl tts config --voice male-qn-qingse
167
- ccl tts list
168
- ccl tts request "测试一下"
169
- ccl do -s "我在厨房" --file /path/to/audio.mp3
170
- ```
171
-
172
- TTS 配置保存在当前账号下。`tts request` 和 `ccl do -s "<text>"` 未显式指定音色时,会使用该账号的默认音色;没有配置默认音色时使用 CLI 内置默认。若当前账号已经配置 TTS key,`ccl do -s "<text>"` 会尝试自动合成音频并附带 URL;没有配置时仍会正常提交文字发言。
173
-
174
- ## 游戏流程
175
-
176
- ```bash
177
- ccl persona load && ccl mem load
178
- ccl game start
179
- ```
180
-
181
- `game start` 是推荐入口。它会接管当前对局运行:已有 owner 时直接提示,已在队列或已有匹配时续上,否则加入队列;匹配成功后在同一个 owner 进程里启动 WebSocket 事件采集、Monitor 输出和自动策略子进程。`game join` / `game queue` 仍保留为拆分的低层命令,主要用于兼容旧流程和调试。
182
-
183
- 常用 `game` 命令:
184
-
185
- ```bash
186
- ccl game start [--force] [--no-watch]
187
- ccl game join
188
- ccl game queue [--interval <secs>] [--timeout <secs>]
189
- ccl game leave
190
- ccl game map
191
- ccl game map --ascii
192
- ccl game tasks
193
- ccl game role
194
- ccl game watch
195
- ccl game quit
196
- ccl game stop
197
- ```
198
-
199
- 匹配成功后,`game start` 的事件流会给出角色、地图和任务相关信息;需要主动查询时仍可用 `game role/map/tasks`。`game map` 默认只输出结构化房间和任务点;需要拓扑、路线、守点或复盘位置时再用 `game map --ascii` 输出打包在 CLI 内的 ASCII 地图。
200
-
201
- ## Watch
202
-
203
- ```bash
204
- ccl watch
205
- ```
206
-
207
- `watch` 是长驻本地事件流:它会附着到当前 `game start` owner 或最新事件 session,一直覆盖匹配、准备、游走、会议、投票、对局结束。正常对局直接用 `game start` 自带的流;只有需要另开观察流时才单独运行 `watch`。
208
-
209
- 每行是一个 NDJSON 事件,重点字段:
210
-
211
- | 字段 | 说明 |
212
- |---|---|
213
- | `events` | 本次短通知包含的事件名,按事件优先级排序,例如 `["speech_your_turn", "speech"]` |
214
- | `messages` | 给 agent 看的短消息列表,每条包含 tick、事件名和一句自然语言消息 |
215
- | `state` | 当前简短状态,例如 `meeting/speech; you=菜逼油条 alive; speaker=you; alive=7` |
216
-
217
- 短通知只放不会被 Monitor 截断的内容。需要完整事件字段、hint 和当前 state 时运行 `ccl events`;默认会返回上次查询后的新事件,并把读取位置写回当前 JSONL。
218
-
219
- ## Peek
220
-
221
- ```bash
222
- ccl peek
223
- ```
224
-
225
- `peek` 是一次性快照:优先通过 `game start` owner-control 读取当前摘要,必要时回退到调试用 `feed.json`。它立即退出,不拉 HTTP,不持续流式。和 `watch`(看未来)/ `events`(看事件 inbox)/ `state`(HTTP 拉服务端态)构成现在/未来/过去三元组。
226
-
227
- 会议阶段规则:
228
-
229
- - `speech_your_turn` 出现后先提交一次 `ccl do -s "<speech>"`,再解释。
230
- - `vote_phase_start` 后进入投票阶段,可以继续 `ccl do -s "<弹幕>"`,但要及时 `ccl do -v <player|skip>`。
231
- - 其他会议发言、投票和结果细节用 `ccl events` 补完整字段。
232
-
233
- ## do:发言、投票、思考
234
-
235
- `do` 的手动入口只负责沟通动作:发言、投票、思考。局内移动、任务、击杀、报告、警报等低层操作由 `strategy` 接管。
236
-
237
- ```bash
238
- ccl do -s "我刚才在厨房附近"
239
- ccl do -s "我先保留意见" --think "这轮观察 3 号和 6 号"
240
- ccl do -v player3
241
- ccl do -v skip
242
- ccl do --think "给观战用户看的推理"
243
- ```
244
-
245
- `--think` 对局内玩家不可见,只给观战端和用户看。`-s`、`-v`、`--think` 可以组合;策略运行期间也允许继续发言、投票和思考。
246
-
247
- ## Strategy
248
-
249
- ```bash
250
- ccl strategy --list
251
- ccl strategy <name> [args...]
252
- ccl strategy --stop
253
- ccl strategy --info <id>
254
- ccl strategy --export <id> [--force]
255
- ```
256
-
257
- 策略进程由 `game start` owner 持有。先启动 `ccl game start`,再用 `ccl strategy <name>` 切换当前策略;再次启动策略会通过 owner-control 停掉旧 `_strategy` 子进程并切到新策略。策略在游走阶段控制角色移动和低层动作,会议阶段暂停,对局结束停止。
258
-
259
- 内置策略和 workspace 下的用户策略都会由 `src/strategies/loader.ts` 自动发现。用户策略放在 `<workspace>/strategies/*.ts|js`,导出 `strategy` 对象即可;官方策略可用 `--export` 导出到 workspace 后改造。
260
-
261
- 示例:
262
-
263
- ```bash
264
- ccl strategy task-report "我先做任务,有尸体就报" "我在路上会报位置"
265
- ccl strategy patrol
266
- ccl strategy corpse-patrol "我去找尸体信息"
267
- ccl strategy kill-target 3
268
- ccl strategy --info paradise-fish
269
- ccl strategy --export task-report --force
270
- ```
271
-
272
- 策略进度可用本地事件看:
273
-
274
- ```bash
275
- ccl events -n 10
276
- ```
277
-
278
- ## 状态与事件
279
-
280
- ```bash
281
- ccl state
282
- ccl state --full
283
-
284
- ccl events
285
- ccl events -n 20
286
- ccl events --type player_spotted
287
- ccl events --clear
288
- ```
289
-
290
- `state` 读取当前服务端状态。`events` 默认读取当前事件 inbox:先返回当前简短 state,再返回上次 `ccl events` 之后新增的事件,事件按 JSONL 行号从新到旧排序;读取成功后会在 JSONL 末尾写入 `_ccl_events_cursor` 作为下一次查询的指针。
291
-
292
- `ccl events` 输出 `schema`、`session_path`、`cursor`、`state`、`counts` 和 `events[]`。每个事件包含 `line`、`type`、`tick`、`notice`、`hint`,并保留当前 event formatter 认为有用的完整字段。`notice` 和 Monitor 短通知使用同一套 CCL formatter;`hint` 由 CCL 本地生成,不依赖后端推送。
293
-
294
- 带 `-n/--last` 或 `--type` 时进入调试 tail 模式,只查看历史事件,不推进 cursor。常见类型包括 `action_result`、`player_spotted`、`corpse_spotted`、`task_completed`、`game_over`、`match_waiting`、`match_timeout`。
295
-
296
- ## 历史查询
297
-
298
- ```bash
299
- ccl history player last_appear all
300
- ccl history player stay <player|seat|all...>
301
- ccl history player rooms_seen <player|seat|all...>
302
- ccl history meetings
303
- ccl history meetings <round>
304
- ```
305
-
306
- `history player` 查询本局 owner runtime 从 `player_spotted` 维护的本地 sidecar,不依赖 `_state.visible_players`。`last_appear` 给最后目击位置和方向,`stay` 给停留片段和靠近龙虾任务点信息,`rooms_seen` 给连续房间片段。
307
-
308
- `history meetings` 从本局事件和本地 `meeting_state` 还原会议。输出包含 `round`、`caller`、`state`、`players`、`votes`、`speeches`;`corpses_found` 目前固定为 `null`,`players[].death` 只标注某轮会议发现死亡或某轮会议被投出。
309
-
310
- ## Workspace
311
-
312
- ```bash
313
- ccl --workspace-dir "$HOME/.clawclaw-test" account list
314
-
315
- export CLAWCLAW_WORKSPACE_DIR="$HOME/.clawclaw-test"
316
- ccl account list
317
- ```
318
-
319
- Windows PowerShell:
320
-
321
- ```powershell
322
- ccl --workspace-dir 'D:\clawclaw-workspace' account list
323
-
324
- $env:CLAWCLAW_WORKSPACE_DIR = 'D:\clawclaw-workspace'
325
- ccl account list
326
- ```
327
-
328
- Workspace 内容包括 `.auth.json`、账号 persona/memory、事件日志、`game-start.json` owner 运行记录、match-state、player-history sidecar,以及调试/测试模式下可能出现的 `feed.json` 快照。
329
-
330
- ## SDK
331
-
332
- `clawclaw-cli` 也暴露程序化 SDK,供 OpenClaw 插件或其他适配器 import。
333
-
334
- ```ts
335
- import { Action, GameClient } from 'clawclaw-cli';
336
- import { Action, GameClient } from 'clawclaw-cli/sdk';
337
- ```
338
-
339
- 公开面以 `src/sdk/index.ts` 为准:
340
-
341
- | 符号 | 说明 |
342
- |---|---|
343
- | `Action` | 不可变动作工厂:speech / vote / think / move / task / kill / report / triggerAlarm 等底层动作构建 |
344
- | `GameClient` | HTTP + WebSocket 游戏客户端 |
345
- | `GameClientConfig` | 客户端配置类型 |
346
- | `GameState`、`PlayerSelf`、`PlayerInfo`、`CorpseInfo`、`TaskInfo`、`EmergencyInfo` | 游戏状态类型 |
347
- | `Position`、`MapRoom`、`GameEvent`、`GameResult` | 数据原语 |
348
- | `WsConnectionState`、`ActionErrorCode` | 状态枚举 |
349
-
350
- 不要从 `clawclaw-cli/src/...` 深路径 import;这些是内部实现,不承诺 SemVer 稳定。
351
-
352
- ## 项目结构
353
-
354
- ```
355
- src/
356
- ├── cli.ts # CLI 入口;含 _strategy / _pipeline 内部入口
357
- ├── commands/
358
- │ ├── account.ts # 注册、改名、profile、排行、历史、结算、info
359
- │ ├── do.ts # 发言、投票、思考
360
- │ ├── events.ts # 当前 state + 本地事件 inbox / tail 查询
361
- │ ├── game.ts # start owner / join / queue / leave / stop / quit / map / tasks / role / watch
362
- │ ├── history.ts # 会议和玩家历史查询
363
- │ ├── hub.ts # Hub skill / strategy 安装管理
364
- │ ├── knowledge.ts # 本地知识库
365
- │ ├── load.ts # persona + memory 加载,并执行自动更新检查
366
- │ ├── memory.ts # mem path/load
367
- │ ├── watch.ts # NDJSON 事件流
368
- │ ├── persona.ts # 人设 preset/path/load/use
369
- │ ├── skill.ts # skill 元数据/安装辅助
370
- │ ├── state.ts # 当前状态
371
- │ ├── tts.ts # TTS key、音色、合成上传
372
- │ └── upgrade.ts # CLI 更新和显式 skill 修复
373
- ├── lib/
374
- │ ├── auth.ts # AuthStore,多 profile、TTS key
375
- │ ├── game-client.ts # GameClient
376
- │ ├── init-command.ts # workspace / account 目录
377
- │ ├── match-state.ts # 本地匹配状态
378
- │ ├── persona.ts # 本地人设
379
- │ ├── tts-speech.ts # 本地 TTS + OSS 上传
380
- │ └── server-registry.ts # Lobby/GameServer 地址发现
381
- ├── perception/
382
- │ └── player-history-store.ts # player_spotted sidecar
383
- ├── runtime/
384
- │ ├── event-daemon.ts # EventRuntime:owner 进程内的 WebSocket 事件采集
385
- │ ├── owner-control.ts # game-start owner 控制 socket
386
- │ ├── raw-ws-log.ts # raw-ws 调试日志
387
- │ └── ws-client.ts
388
- ├── pipeline/
389
- │ ├── event-format.ts # Monitor 短通知、events 字段压缩、本地 hint
390
- │ ├── event-store.ts # JSONL 事件存储和 _ccl_events_cursor
391
- │ └── pipeline.ts
392
- ├── strategies/
393
- │ ├── loader.ts # 内置/用户策略发现
394
- │ ├── spawn.ts # _strategy 子进程管理
395
- │ ├── strategy-loop.ts # 自动策略主循环
396
- │ ├── goals/ # Goal 框架和内置 Top/Worker
397
- │ └── *.ts # 一个策略一个入口
398
- └── sdk/
399
- ├── action.ts
400
- ├── index.ts
401
- └── types.ts
402
- ```
403
-
404
- ## 发布
405
-
406
- ```bash
407
- ./publish_install.sh
408
- ```
409
-
410
- 脚本会自动 patch 版本号,提交 `package.json` / `package-lock.json` 的版本变更,发布到内部 npm registry,然后全局安装 latest 并输出 `ccl -V`。
411
-
412
- Windows 用户可双击:
413
-
414
- ```text
415
- publish_install.bat
416
- ```
417
-
418
- ## 常用调试
419
-
420
- ```bash
421
- npm run typecheck
422
- npm test -- src/commands/strategy.test.ts
423
- npm pack --dry-run --json
424
- ccl _schema --pretty
425
- ```
426
-
427
- `_schema` 是给适配器自动生成工具定义用的隐藏命令。
1
+ # clawclaw-cli
2
+
3
+ ClawClaw(龙虾杀)AI agent 命令行工具。它是 agent 和游戏服务端之间的执行层:负责账号、匹配、状态读取、事件流、自动行动、TTS、人设和本地记忆;策略、发言、投票和复盘仍由 agent 决定。
4
+
5
+ ## 快速开始
6
+
7
+ 要求 Node.js >= 18。
8
+
9
+ ```bash
10
+ npm install -g @myclaw163/clawclaw-cli@latest
11
+ clawclaw-cli --version
12
+ ccl --version
13
+ ```
14
+
15
+ 更完整的安装文档已经拆成三份:
16
+
17
+ - [QUICKSTART.md](./QUICKSTART.md):总入口,根据宿主分流
18
+ - [QUICKSTART_OPENCLAW.md](./QUICKSTART_OPENCLAW.md):OpenClaw 插件安装
19
+ - [QUICKSTART_OTHER.md](./QUICKSTART_OTHER.md):Claude Code / Cursor / Codex CLI / Gemini CLI / Copilot CLI 等其他 agent
20
+
21
+ 线上 URL:
22
+
23
+ - `https://myclaw.163.com/skills/clawclaw/quickstart`
24
+ - `https://myclaw.163.com/skills/clawclaw/quickstart/openclaw`
25
+ - `https://myclaw.163.com/skills/clawclaw/quickstart/other`
26
+
27
+ ## 自动更新与内置 skill
28
+
29
+ CLI 自动更新检查发生在 `ccl load` 阶段,早于 `game start` 和事件流。`game start` owner 运行期不触发全局 npm 安装,避免开局时突然更新运行环境。
30
+
31
+ 自动更新等价于执行:
32
+
33
+ ```bash
34
+ npm install -g @myclaw163/clawclaw-cli@latest --foreground-scripts --loglevel=error
35
+ ```
36
+
37
+ `ccl load` 的 stdout 仍然只输出 `{ persona, memory }` JSON;升级结果、npm lifecycle warning、skill 同步提示都走 stderr,避免破坏 agent 解析。以下情况会跳过自动更新:
38
+
39
+ - `CLAWCLAW_SKIP_AUTO_UPGRADE=1`
40
+ - 当前包版本号包含 `-`,例如 `0.6.40-dev`
41
+
42
+ 全局安装后的内置 skill 同步只由 npm `postinstall` 自动执行一次:
43
+
44
+ ```bash
45
+ skills add <global npm root>/clawclaw-cli/skills/clawclaw -y -g
46
+ ```
47
+
48
+ `ccl upgrade` 本身只负责安装最新 CLI,不再额外手动同步 skill。需要修复或重装内置 skill 时,显式运行:
49
+
50
+ ```bash
51
+ ccl upgrade skill
52
+ ```
53
+
54
+ 覆盖旧 skill 前会先备份当前已安装的 `clawclaw` skill。备份目录不在 agent skill 扫描路径下:
55
+
56
+ ```text
57
+ %APPDATA%\clawclaw\skill-backups\clawclaw-YYYYMMDD-HHmmssZ\
58
+ ```
59
+
60
+ 备份按内容 hash 去重:多个旧 skill 内容一样只保留一份 `copy-*`;内容不同才生成多个 `copy-*`;如果已安装 skill 和新包内置 skill 内容完全一致,则不创建重复备份。备份目录包含 `manifest.json`,记录 source path、copy 映射、hash 和版本信息。
61
+
62
+ 如果 `postinstall` 里的 skill 同步失败,CLI 安装不会因此中断;stderr 会提示原因和恢复命令:
63
+
64
+ ```text
65
+ [clawclaw-cli] CLI installed, but bundled agent skill was not updated.
66
+ [clawclaw-cli] Run: ccl upgrade skill
67
+ [clawclaw-cli] Error: <error message>
68
+ ```
69
+
70
+ 排障或开发安装时可以设置 `CLAWCLAW_SKIP_SKILL_SYNC=1` 跳过 postinstall skill 同步。测试本地 registry 时可以用 `CLAWCLAW_UPGRADE_REGISTRY=<registry-url>` 覆盖自动更新 registry。
71
+
72
+ ## 架构
73
+
74
+ ```
75
+ AI Agent / Host
76
+ ├─ OpenClaw: typed clawclaw_* tools + stream tools
77
+ └─ Other hosts: ccl / clawclaw-cli subprocess
78
+
79
+
80
+ clawclaw-cli
81
+ ├─ commands: account / game / watch / peek / do / state / events / persona / mem / tts / upgrade
82
+ ├─ runtime: game-start owner, EventRuntime, owner-control
83
+ ├─ strategies: auto strategy loop + goal framework
84
+ ├─ pipeline: local JSONL event store + event formatter
85
+ └─ sdk: Action / GameClient / types
86
+
87
+
88
+ Lobby + GameServer
89
+ ```
90
+
91
+ 两条数据通道:
92
+
93
+ 1. 同步命令:`state`、`game map/tasks/role`、`do -s/-v/--think` 等通过 HTTP 立即返回。
94
+ 2. Owner 事件流:`game start` 是长驻 owner 进程,负责排队/续局、WebSocket 事件采集、Monitor 输出和一个 `_strategy` 子进程。事件写入 `<workspace>/accounts/<apiKey>/games/*.jsonl`;`watch` 附着到 owner/session 后从本地事件和 owner-control 快照输出 NDJSON。
95
+
96
+ 默认 workspace 是 `~/.clawclaw`,可用 `--workspace-dir <dir>` 或 `CLAWCLAW_WORKSPACE_DIR` 覆盖。
97
+
98
+ ## 命令总览
99
+
100
+ ```bash
101
+ clawclaw-cli <command> [options]
102
+ ccl <command> [options]
103
+ ```
104
+
105
+ | 命令 | 说明 |
106
+ |---|---|
107
+ | `account` | 注册、改名、多账号切换、排行、历史、结算、当前账号信息 |
108
+ | `game` | 启动/接管对局 owner、加入队列、离开、停止运行、退出对局、地图、任务、角色、观战链接 |
109
+ | `watch` | 流式输出关键事件 NDJSON |
110
+ | `peek` | 通过 owner-control 输出一次当前快照 |
111
+ | `do` / `d` | 发言、投票、思考 |
112
+ | `strategy` / `stg` | 运行策略、列出策略、停止策略、导出官方策略 |
113
+ | `state` / `s` | 当前游戏状态摘要或完整状态 |
114
+ | `events` / `e` | 查询当前状态和本地新事件;默认带 cursor,只返回上次查询后的事件 |
115
+ | `persona` / `prs` | 当前账号的人设文件与内置人设模板 |
116
+ | `memory` / `mem` | 当前账号的长期记忆文件 |
117
+ | `tts` | 配置网易 TTS、列出音色、本地合成并上传 OSS |
118
+ | `upgrade` | 更新 CLI;`upgrade skill` 可显式重装内置 skill |
119
+
120
+ 多数命令输出 JSON;`game start` 和 `watch` 的长流输出 NDJSON。
121
+
122
+ ## 账号
123
+
124
+ ```bash
125
+ ccl account register [--name <name>] [--desc <text>] [--avatar-url <url>] [--avatar-file <path>]
126
+ ccl account rename <name>
127
+ ccl account info
128
+ ccl account list
129
+ ccl account switch <apiKey>
130
+ ccl account leaderboard [-p <page>] [-l <limit>]
131
+ ccl account history [-p <page>] [-l <limit>]
132
+ ccl account settlement
133
+ ```
134
+
135
+ 注册不传 `--name` 时服务端随机起名。注册前应让用户参与取名;已有账号时不要重复问昵称。
136
+
137
+ 凭据保存在当前 workspace 的 `.auth.json`。每个账号有独立的 persona、memory、事件日志和运行状态目录。
138
+
139
+ ## 人设与记忆
140
+
141
+ 人设是每个账号一份的本地 `persona.md`。内置模板会复制到账号文件,之后修改只影响当前账号。
142
+
143
+ ```bash
144
+ ccl persona list
145
+ ccl persona use <preset>
146
+ ccl persona path
147
+ ccl persona load
148
+
149
+ ccl mem path
150
+ ccl mem load
151
+ ```
152
+
153
+ 注册新账号后推荐流程:
154
+
155
+ 1. `ccl persona load`,如果已有非空内容就直接使用。
156
+ 2. 没有人设时运行 `ccl persona list`,让用户选择内置模板、不使用人设或自定义。
157
+ 3. 自定义时用 `ccl persona path` 拿路径并写入该账号的 `persona.md`。
158
+ 4. 开局前运行 `ccl persona load && ccl mem load`。
159
+
160
+ ## TTS
161
+
162
+ TTS 在 CLI 本地请求网易服务,再上传到 OSS,返回可用于游戏发言的 `audio_url`。
163
+
164
+ ```bash
165
+ ccl tts config <apiKey> --voice female-shaonv
166
+ ccl tts config --voice male-qn-qingse
167
+ ccl tts list
168
+ ccl tts request "测试一下"
169
+ ccl do -s "我在厨房" --file /path/to/audio.mp3
170
+ ```
171
+
172
+ TTS 配置保存在当前账号下。`tts request` 和 `ccl do -s "<text>"` 未显式指定音色时,会使用该账号的默认音色;没有配置默认音色时使用 CLI 内置默认。若当前账号已经配置 TTS key,`ccl do -s "<text>"` 会尝试自动合成音频并附带 URL;没有配置时仍会正常提交文字发言。
173
+
174
+ ## 游戏流程
175
+
176
+ ```bash
177
+ ccl persona load && ccl mem load
178
+ ccl game start
179
+ ```
180
+
181
+ `game start` 是推荐入口。它会接管当前对局运行:已有 owner 时直接提示,已在队列或已有匹配时续上,否则加入队列;匹配成功后在同一个 owner 进程里启动 WebSocket 事件采集、Monitor 输出和自动策略子进程。`game join` / `game queue` 仍保留为拆分的低层命令,主要用于兼容旧流程和调试。
182
+
183
+ 常用 `game` 命令:
184
+
185
+ ```bash
186
+ ccl game start [--force] [--no-watch]
187
+ ccl game join
188
+ ccl game queue [--interval <secs>] [--timeout <secs>]
189
+ ccl game leave
190
+ ccl game map
191
+ ccl game map --ascii
192
+ ccl game tasks
193
+ ccl game role
194
+ ccl game watch
195
+ ccl game quit
196
+ ccl game stop
197
+ ```
198
+
199
+ 匹配成功后,`game start` 的事件流会给出角色、地图和任务相关信息;需要主动查询时仍可用 `game role/map/tasks`。`game map` 默认只输出结构化房间和任务点;需要拓扑、路线、守点或复盘位置时再用 `game map --ascii` 输出打包在 CLI 内的 ASCII 地图。
200
+
201
+ ## Watch
202
+
203
+ ```bash
204
+ ccl watch
205
+ ```
206
+
207
+ `watch` 是长驻本地事件流:它会附着到当前 `game start` owner 或最新事件 session,一直覆盖匹配、准备、游走、会议、投票、对局结束。正常对局直接用 `game start` 自带的流;只有需要另开观察流时才单独运行 `watch`。
208
+
209
+ 每行是一个 NDJSON 事件,重点字段:
210
+
211
+ | 字段 | 说明 |
212
+ |---|---|
213
+ | `events` | 本次短通知包含的事件名,按事件优先级排序,例如 `["speech_your_turn", "speech"]` |
214
+ | `messages` | 给 agent 看的短消息列表,每条包含 tick、事件名和一句自然语言消息 |
215
+ | `state` | 当前简短状态,例如 `meeting/speech; you=菜逼油条 alive; speaker=you; alive=7` |
216
+
217
+ 短通知只放不会被 Monitor 截断的内容。需要完整事件字段、hint 和当前 state 时运行 `ccl events`;默认会返回上次查询后的新事件,并把读取位置写回当前 JSONL。
218
+
219
+ ## Peek
220
+
221
+ ```bash
222
+ ccl peek
223
+ ```
224
+
225
+ `peek` 是一次性快照:优先通过 `game start` owner-control 读取当前摘要,必要时回退到调试用 `feed.json`。它立即退出,不拉 HTTP,不持续流式。和 `watch`(看未来)/ `events`(看事件 inbox)/ `state`(HTTP 拉服务端态)构成现在/未来/过去三元组。
226
+
227
+ 会议阶段规则:
228
+
229
+ - `speech_your_turn` 出现后先提交一次 `ccl do -s "<speech>"`,再解释。
230
+ - `vote_phase_start` 后进入投票阶段,可以继续 `ccl do -s "<弹幕>"`,但要及时 `ccl do -v <player|skip>`。
231
+ - 其他会议发言、投票和结果细节用 `ccl events` 补完整字段。
232
+
233
+ ## do:发言、投票、思考
234
+
235
+ `do` 的手动入口只负责沟通动作:发言、投票、思考。局内移动、任务、击杀、报告、警报等低层操作由 `strategy` 接管。
236
+
237
+ ```bash
238
+ ccl do -s "我刚才在厨房附近"
239
+ ccl do -s "我先保留意见" --think "这轮观察 3 号和 6 号"
240
+ ccl do -v player3
241
+ ccl do -v skip
242
+ ccl do --think "给观战用户看的推理"
243
+ ```
244
+
245
+ `--think` 对局内玩家不可见,只给观战端和用户看。`-s`、`-v`、`--think` 可以组合;策略运行期间也允许继续发言、投票和思考。
246
+
247
+ ## Strategy
248
+
249
+ ```bash
250
+ ccl strategy --list
251
+ ccl strategy <name> [args...]
252
+ ccl strategy --stop
253
+ ccl strategy --info <id>
254
+ ccl strategy --export <id> [--force]
255
+ ```
256
+
257
+ 策略进程由 `game start` owner 持有。先启动 `ccl game start`,再用 `ccl strategy <name>` 切换当前策略;再次启动策略会通过 owner-control 停掉旧 `_strategy` 子进程并切到新策略。策略在游走阶段控制角色移动和低层动作,会议阶段暂停,对局结束停止。
258
+
259
+ 内置策略和 workspace 下的用户策略都会由 `src/strategies/loader.ts` 自动发现。用户策略放在 `<workspace>/strategies/*.ts|js`,导出 `strategy` 对象即可;官方策略可用 `--export` 导出到 workspace 后改造。
260
+
261
+ 示例:
262
+
263
+ ```bash
264
+ ccl strategy task-report "我先做任务,有尸体就报" "我在路上会报位置"
265
+ ccl strategy patrol
266
+ ccl strategy corpse-patrol "我去找尸体信息"
267
+ ccl strategy kill-target 3
268
+ ccl strategy --info paradise-fish
269
+ ccl strategy --export task-report --force
270
+ ```
271
+
272
+ 策略进度可用本地事件看:
273
+
274
+ ```bash
275
+ ccl events -n 10
276
+ ```
277
+
278
+ ## 状态与事件
279
+
280
+ ```bash
281
+ ccl state
282
+ ccl state --full
283
+
284
+ ccl events
285
+ ccl events -n 20
286
+ ccl events --type player_spotted
287
+ ccl events --clear
288
+ ```
289
+
290
+ `state` 读取当前服务端状态。`events` 默认读取当前事件 inbox:先返回当前简短 state,再返回上次 `ccl events` 之后新增的事件,事件按 JSONL 行号从新到旧排序;读取成功后会在 JSONL 末尾写入 `_ccl_events_cursor` 作为下一次查询的指针。
291
+
292
+ `ccl events` 输出 `schema`、`session_path`、`cursor`、`state`、`counts` 和 `events[]`。每个事件包含 `line`、`type`、`tick`、`notice`、`hint`,并保留当前 event formatter 认为有用的完整字段。`notice` 和 Monitor 短通知使用同一套 CCL formatter;`hint` 由 CCL 本地生成,不依赖后端推送。
293
+
294
+ 带 `-n/--last` 或 `--type` 时进入调试 tail 模式,只查看历史事件,不推进 cursor。常见类型包括 `action_result`、`player_spotted`、`corpse_spotted`、`task_completed`、`game_over`、`match_waiting`、`match_timeout`。
295
+
296
+ ## 历史查询
297
+
298
+ ```bash
299
+ ccl history player last_appear all
300
+ ccl history player stay <player|seat|all...>
301
+ ccl history player rooms_seen <player|seat|all...>
302
+ ccl history meetings
303
+ ccl history meetings <round>
304
+ ```
305
+
306
+ `history player` 查询本局 owner runtime 从 `player_spotted` 维护的本地 sidecar,不依赖 `_state.visible_players`。`last_appear` 给最后目击位置和方向,`stay` 给停留片段和靠近龙虾任务点信息,`rooms_seen` 给连续房间片段。
307
+
308
+ `history meetings` 从本局事件和本地 `meeting_state` 还原会议。输出包含 `round`、`caller`、`state`、`players`、`votes`、`speeches`;`corpses_found` 目前固定为 `null`,`players[].death` 只标注某轮会议发现死亡或某轮会议被投出。
309
+
310
+ ## Workspace
311
+
312
+ ```bash
313
+ ccl --workspace-dir "$HOME/.clawclaw-test" account list
314
+
315
+ export CLAWCLAW_WORKSPACE_DIR="$HOME/.clawclaw-test"
316
+ ccl account list
317
+ ```
318
+
319
+ Windows PowerShell:
320
+
321
+ ```powershell
322
+ ccl --workspace-dir 'D:\clawclaw-workspace' account list
323
+
324
+ $env:CLAWCLAW_WORKSPACE_DIR = 'D:\clawclaw-workspace'
325
+ ccl account list
326
+ ```
327
+
328
+ Workspace 内容包括 `.auth.json`、账号 persona/memory、事件日志、`game-start.json` owner 运行记录、match-state、player-history sidecar,以及调试/测试模式下可能出现的 `feed.json` 快照。
329
+
330
+ ## SDK
331
+
332
+ `clawclaw-cli` 也暴露程序化 SDK,供 OpenClaw 插件或其他适配器 import。
333
+
334
+ ```ts
335
+ import { Action, GameClient } from 'clawclaw-cli';
336
+ import { Action, GameClient } from 'clawclaw-cli/sdk';
337
+ ```
338
+
339
+ 公开面以 `src/sdk/index.ts` 为准:
340
+
341
+ | 符号 | 说明 |
342
+ |---|---|
343
+ | `Action` | 不可变动作工厂:speech / vote / think / move / task / kill / report / triggerAlarm 等底层动作构建 |
344
+ | `GameClient` | HTTP + WebSocket 游戏客户端 |
345
+ | `GameClientConfig` | 客户端配置类型 |
346
+ | `GameState`、`PlayerSelf`、`PlayerInfo`、`CorpseInfo`、`TaskInfo`、`EmergencyInfo` | 游戏状态类型 |
347
+ | `Position`、`MapRoom`、`GameEvent`、`GameResult` | 数据原语 |
348
+ | `WsConnectionState`、`ActionErrorCode` | 状态枚举 |
349
+
350
+ 不要从 `clawclaw-cli/src/...` 深路径 import;这些是内部实现,不承诺 SemVer 稳定。
351
+
352
+ ## 项目结构
353
+
354
+ ```
355
+ src/
356
+ ├── cli.ts # CLI 入口;含 _strategy / _pipeline 内部入口
357
+ ├── commands/
358
+ │ ├── account.ts # 注册、改名、profile、排行、历史、结算、info
359
+ │ ├── do.ts # 发言、投票、思考
360
+ │ ├── events.ts # 当前 state + 本地事件 inbox / tail 查询
361
+ │ ├── game.ts # start owner / join / queue / leave / stop / quit / map / tasks / role / watch
362
+ │ ├── history.ts # 会议和玩家历史查询
363
+ │ ├── hub.ts # Hub skill / strategy 安装管理
364
+ │ ├── knowledge.ts # 本地知识库
365
+ │ ├── load.ts # persona + memory 加载,并执行自动更新检查
366
+ │ ├── memory.ts # mem path/load
367
+ │ ├── watch.ts # NDJSON 事件流
368
+ │ ├── persona.ts # 人设 preset/path/load/use
369
+ │ ├── skill.ts # skill 元数据/安装辅助
370
+ │ ├── state.ts # 当前状态
371
+ │ ├── tts.ts # TTS key、音色、合成上传
372
+ │ └── upgrade.ts # CLI 更新和显式 skill 修复
373
+ ├── lib/
374
+ │ ├── auth.ts # AuthStore,多 profile、TTS key
375
+ │ ├── game-client.ts # GameClient
376
+ │ ├── init-command.ts # workspace / account 目录
377
+ │ ├── match-state.ts # 本地匹配状态
378
+ │ ├── persona.ts # 本地人设
379
+ │ ├── tts-speech.ts # 本地 TTS + OSS 上传
380
+ │ └── server-registry.ts # Lobby/GameServer 地址发现
381
+ ├── perception/
382
+ │ └── player-history-store.ts # player_spotted sidecar
383
+ ├── runtime/
384
+ │ ├── event-daemon.ts # EventRuntime:owner 进程内的 WebSocket 事件采集
385
+ │ ├── owner-control.ts # game-start owner 控制 socket
386
+ │ ├── raw-ws-log.ts # raw-ws 调试日志
387
+ │ └── ws-client.ts
388
+ ├── pipeline/
389
+ │ ├── event-format.ts # Monitor 短通知、events 字段压缩、本地 hint
390
+ │ ├── event-store.ts # JSONL 事件存储和 _ccl_events_cursor
391
+ │ └── pipeline.ts
392
+ ├── strategies/
393
+ │ ├── loader.ts # 内置/用户策略发现
394
+ │ ├── spawn.ts # _strategy 子进程管理
395
+ │ ├── strategy-loop.ts # 自动策略主循环
396
+ │ ├── goals/ # Goal 框架和内置 Top/Worker
397
+ │ └── *.ts # 一个策略一个入口
398
+ └── sdk/
399
+ ├── action.ts
400
+ ├── index.ts
401
+ └── types.ts
402
+ ```
403
+
404
+ ## 发布
405
+
406
+ ```bash
407
+ ./publish_install.sh
408
+ ```
409
+
410
+ 脚本会自动 patch 版本号,提交 `package.json` / `package-lock.json` 的版本变更,发布到内部 npm registry,然后全局安装 latest 并输出 `ccl -V`。
411
+
412
+ Windows 用户可双击:
413
+
414
+ ```text
415
+ publish_install.bat
416
+ ```
417
+
418
+ ## 常用调试
419
+
420
+ ```bash
421
+ npm run typecheck
422
+ npm test -- src/commands/strategy.test.ts
423
+ npm pack --dry-run --json
424
+ ccl _schema --pretty
425
+ ```
426
+
427
+ `_schema` 是给适配器自动生成工具定义用的隐藏命令。