@kodax-ai/kodax-cli 0.7.38

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 (44) hide show
  1. package/CHANGELOG.md +1304 -0
  2. package/LICENSE +191 -0
  3. package/README.md +1167 -0
  4. package/README_CN.md +631 -0
  5. package/dist/builtin/code-review/SKILL.md +63 -0
  6. package/dist/builtin/git-workflow/SKILL.md +84 -0
  7. package/dist/builtin/skill-creator/SKILL.md +122 -0
  8. package/dist/builtin/skill-creator/agents/analyzer.md +12 -0
  9. package/dist/builtin/skill-creator/agents/comparator.md +13 -0
  10. package/dist/builtin/skill-creator/agents/grader.md +13 -0
  11. package/dist/builtin/skill-creator/references/schemas.md +227 -0
  12. package/dist/builtin/skill-creator/scripts/aggregate-benchmark.d.ts +46 -0
  13. package/dist/builtin/skill-creator/scripts/aggregate-benchmark.js +209 -0
  14. package/dist/builtin/skill-creator/scripts/analyze-benchmark.d.ts +46 -0
  15. package/dist/builtin/skill-creator/scripts/analyze-benchmark.js +289 -0
  16. package/dist/builtin/skill-creator/scripts/compare-runs.d.ts +62 -0
  17. package/dist/builtin/skill-creator/scripts/compare-runs.js +333 -0
  18. package/dist/builtin/skill-creator/scripts/generate-review.d.ts +33 -0
  19. package/dist/builtin/skill-creator/scripts/generate-review.js +415 -0
  20. package/dist/builtin/skill-creator/scripts/grade-evals.d.ts +73 -0
  21. package/dist/builtin/skill-creator/scripts/grade-evals.js +405 -0
  22. package/dist/builtin/skill-creator/scripts/improve-description.d.ts +23 -0
  23. package/dist/builtin/skill-creator/scripts/improve-description.js +161 -0
  24. package/dist/builtin/skill-creator/scripts/init-skill.d.ts +14 -0
  25. package/dist/builtin/skill-creator/scripts/init-skill.js +153 -0
  26. package/dist/builtin/skill-creator/scripts/install-skill.d.ts +29 -0
  27. package/dist/builtin/skill-creator/scripts/install-skill.js +176 -0
  28. package/dist/builtin/skill-creator/scripts/package-skill.d.ts +38 -0
  29. package/dist/builtin/skill-creator/scripts/package-skill.js +124 -0
  30. package/dist/builtin/skill-creator/scripts/quick-validate.d.ts +8 -0
  31. package/dist/builtin/skill-creator/scripts/quick-validate.js +166 -0
  32. package/dist/builtin/skill-creator/scripts/run-eval.d.ts +66 -0
  33. package/dist/builtin/skill-creator/scripts/run-eval.js +356 -0
  34. package/dist/builtin/skill-creator/scripts/run-loop.d.ts +49 -0
  35. package/dist/builtin/skill-creator/scripts/run-loop.js +243 -0
  36. package/dist/builtin/skill-creator/scripts/run-trigger-eval.d.ts +58 -0
  37. package/dist/builtin/skill-creator/scripts/run-trigger-eval.js +225 -0
  38. package/dist/builtin/skill-creator/scripts/utils.js +278 -0
  39. package/dist/builtin/tdd/SKILL.md +56 -0
  40. package/dist/index.js +1717 -0
  41. package/dist/kodax_cli.js +1870 -0
  42. package/package.json +122 -0
  43. package/scripts/kodax-bin.cjs +27 -0
  44. package/scripts/production-env.cjs +16 -0
package/README_CN.md ADDED
@@ -0,0 +1,631 @@
1
+ # KodaX
2
+
3
+ 轻量、透明、可定制的 TypeScript AI Coding Agent。
4
+
5
+ KodaX 既可以作为命令行工具使用,也可以作为库集成到你的项目里,还能打包成**免 Node 运行时**的单文件二进制分发到目标机器。当前支持 12 个模型提供商,包含完整的 REPL、会话、30+ 工具、Skills,以及 Scout-first 自适应多 Agent 工作流。
6
+
7
+ ## 为什么用 KodaX
8
+
9
+ - 透明:代码结构清晰,便于阅读、修改和调试。
10
+ - 灵活:支持多 provider,方便切换模型和网关。
11
+ - 可定制:prompts、tools、skills、session 流程都能改。
12
+ - 可复用:不只是 CLI,也可以把其中一层当库来使用。
13
+
14
+ 如果你关心:
15
+
16
+ - 想理解 AI coding agent 是怎么工作的
17
+ - 不想被单一 provider 绑定
18
+ - 希望 agent 逻辑能自己控制
19
+ - 需要一套适合长期开发任务的工程化工作流
20
+
21
+ 那 KodaX 会比单纯依赖某个黑盒托管产品更合适。
22
+
23
+ ## 快速开始
24
+
25
+ ### 1. 安装并构建
26
+
27
+ ```bash
28
+ git clone https://github.com/icetomoyo/KodaX.git
29
+ cd KodaX
30
+ npm install
31
+ npm run build
32
+ npm link
33
+ ```
34
+
35
+ 构建完成后就可以直接启动:
36
+
37
+ ```bash
38
+ kodax
39
+ ```
40
+
41
+ ### 2. 配置模型提供商
42
+
43
+ 最简单的方式是先设置 API Key:
44
+
45
+ ```bash
46
+ # macOS / Linux
47
+ export ZHIPU_API_KEY=your_api_key
48
+
49
+ # PowerShell
50
+ $env:ZHIPU_API_KEY="your_api_key"
51
+ ```
52
+
53
+ 然后在 `~/.kodax/config.json` 里写一个最小配置:
54
+
55
+ ```json
56
+ {
57
+ "provider": "zhipu-coding",
58
+ "reasoningMode": "auto"
59
+ }
60
+ ```
61
+
62
+ ### 3. 启动 REPL 或执行单次任务
63
+
64
+ ```bash
65
+ # 进入交互式 REPL
66
+ kodax
67
+
68
+ # 单次任务
69
+ kodax "Review this repository and summarize the architecture"
70
+ ```
71
+
72
+ 进入 REPL 后,你可以直接自然语言提问,也可以使用命令:
73
+
74
+ ```text
75
+ /help
76
+ /mode
77
+ /agent-mode ama
78
+ ```
79
+
80
+ ### 4. 作为库使用
81
+
82
+ ```typescript
83
+ import { runKodaX } from 'kodax';
84
+
85
+ const result = await runKodaX(
86
+ {
87
+ provider: 'zhipu-coding',
88
+ reasoningMode: 'auto',
89
+ },
90
+ 'Explain this codebase'
91
+ );
92
+ ```
93
+
94
+ ### 5. 自定义 Provider(OpenAI / Anthropic 兼容端点)
95
+
96
+ 任何 OpenAI 或 Anthropic 协议兼容的 endpoint 都可以通过 `customProviders[]` 接入,CLI 模式写在 `~/.kodax/config.json` 里:
97
+
98
+ ```json
99
+ {
100
+ "provider": "my-openai-compatible",
101
+ "customProviders": [
102
+ {
103
+ "name": "my-openai-compatible",
104
+ "protocol": "openai",
105
+ "baseUrl": "https://example.com/v1",
106
+ "apiKeyEnv": "MY_LLM_API_KEY",
107
+ "model": "my-model",
108
+ "userAgentMode": "compat"
109
+ }
110
+ ]
111
+ }
112
+ ```
113
+
114
+ `userAgentMode` 默认 `"compat"`(发送 `KodaX` 而非上游 SDK 的 User-Agent);如果你的网关要求原生 SDK header,再切到 `"sdk"`。
115
+
116
+ 库模式下用 `registerCustomProviders()` 显式注册:
117
+
118
+ ```typescript
119
+ import { registerCustomProviders, runKodaX } from 'kodax';
120
+
121
+ registerCustomProviders([
122
+ {
123
+ name: 'my-openai-compatible',
124
+ protocol: 'openai',
125
+ baseUrl: 'https://example.com/v1',
126
+ apiKeyEnv: 'MY_LLM_API_KEY',
127
+ model: 'my-model',
128
+ userAgentMode: 'compat',
129
+ },
130
+ ]);
131
+
132
+ await runKodaX({ provider: 'my-openai-compatible' }, '解释这个仓库');
133
+ ```
134
+
135
+ ### 6. 打包成单文件二进制(无需 Node)
136
+
137
+ KodaX 可以用 `bun --compile` 打包成单可执行文件 + 一个 `builtin/` sidecar 目录,目标机器**不需要安装 Node.js 或任何运行时**。
138
+
139
+ 支持目标:`win-x64`、`linux-x64`、`linux-arm64`、`darwin-x64`、`darwin-arm64`。Win7 / glibc < 2.27 的发行版 / 龙芯 LoongArch 暂不支持。
140
+
141
+ 本地构建:
142
+
143
+ ```bash
144
+ # 先在构建机器上装好 Bun(一次性)
145
+ npm i -g bun # 或 scoop / brew / curl,详见 docs/release.md
146
+
147
+ npm run build:binary # 当前平台(最快)
148
+ npm run build:binary:all # 一台机器出全部 5 个目标
149
+ node scripts/build-binary.mjs --target=linux-arm64 # 指定平台
150
+ ```
151
+
152
+ 产物在 `dist/binary/<target>/`:
153
+
154
+ ```
155
+ dist/binary/linux-x64/
156
+ ├── kodax # ~60 MB Bun 编译的二进制
157
+ └── builtin/ # 内置 skills sidecar
158
+ ```
159
+
160
+ 冒烟验证:`dist/binary/<host>/kodax --version`。
161
+
162
+ **自动发布**:推送 `v*` git tag 会触发 `.github/workflows/release.yml`,在原生 runner 上构建全部 5 个目标、跑冒烟测试,然后自动创建 GitHub Release 并上传 archives + SHA256SUMS。也可以从 Actions UI 用 `workflow_dispatch` 不打 tag 跑流水线测试。
163
+
164
+ 详细的构建参数、archive 结构、`KODAX_BUNDLED` / `KODAX_VERSION` build-time defines、故障排查,参见 [docs/release.md](docs/release.md)。
165
+
166
+ ## 内置 Provider 列表
167
+
168
+ | Provider | 环境变量 | Reasoning | 默认 Model |
169
+ |----------|----------|-----------|-----------|
170
+ | anthropic | `ANTHROPIC_API_KEY` | Native | claude-sonnet-4-6 |
171
+ | openai | `OPENAI_API_KEY` | Native | gpt-5.3-codex |
172
+ | kimi | `KIMI_API_KEY` | Native | kimi-k2.6 |
173
+ | kimi-code | `KIMI_API_KEY` | Native | kimi-for-coding |
174
+ | qwen | `QWEN_API_KEY` | Native | qwen3.5-plus |
175
+ | zhipu | `ZHIPU_API_KEY` | Native | glm-5 |
176
+ | zhipu-coding | `ZHIPU_API_KEY` | Native | glm-5(GLM Coding Plan 端点) |
177
+ | minimax-coding | `MINIMAX_API_KEY` | Native | MiniMax-M2.7 |
178
+ | mimo-coding | `MIMO_API_KEY` | Native | mimo-v2.5-pro(小米 MiMo Token Plan,Anthropic 协议) |
179
+ | deepseek | `DEEPSEEK_API_KEY` | Native | deepseek-v4-flash |
180
+ | gemini-cli | `GEMINI_API_KEY` | Prompt-only / CLI bridge | (通过 gemini CLI) |
181
+ | codex-cli | `OPENAI_API_KEY` | Prompt-only / CLI bridge | (通过 codex CLI) |
182
+
183
+ > 不在表里的端点:用上面"自定义 Provider"那一节加进来即可。
184
+
185
+ ## 内置工具一览
186
+
187
+ KodaX 有 30+ 个内置工具,按类别分组如下(实际暴露给 LLM 是一张扁平表)。
188
+
189
+ **文件操作**
190
+
191
+ | 工具 | 说明 |
192
+ |------|------|
193
+ | `read` | 读取文件(支持 offset / limit) |
194
+ | `write` | 创建新文件或完整重写 |
195
+ | `edit` | 精确字符串替换(支持 `replace_all`) |
196
+ | `multi_edit` | 对同一文件做一批独立 edit,整批原子提交 |
197
+ | `insert_after_anchor` | 在唯一 anchor 后插入内容,避免整文件重写 |
198
+ | `undo` | 撤销最近一次文件修改 |
199
+
200
+ **Shell 与搜索**
201
+
202
+ | 工具 | 说明 |
203
+ |------|------|
204
+ | `bash` | 执行 shell 命令(支持后台、输出截断) |
205
+ | `glob` / `grep` | 文件名匹配 / 正则内容搜索 |
206
+ | `code_search` | 代码搜索,比裸 grep 噪音更低 |
207
+ | `semantic_lookup` | 借助 repo intelligence 的符号 / 模块 / 流程感知查找 |
208
+ | `web_search` / `web_fetch` | 联网搜索 / 抓取,自带 trust + 时效信号 |
209
+
210
+ **Repo Intelligence working tools**
211
+
212
+ | 工具 | 说明 |
213
+ |------|------|
214
+ | `repo_overview` | 仓库结构、关键区域、入口提示、intelligence 快照 |
215
+ | `changed_scope` | 当前 diff 涉及的文件 / 区域 / 类别 |
216
+ | `changed_diff` / `changed_diff_bundle` | 单文件 / 多文件分页 diff |
217
+ | `module_context` | 模块 capsule(依赖、入口、符号、测试、文档) |
218
+ | `symbol_context` | 定义 + 可能的 caller/callee + 备选 |
219
+ | `process_context` | 入口的近似静态执行/流程 capsule |
220
+ | `impact_estimate` | 符号 / 路径 / 模块的影响面估算 |
221
+
222
+ **MCP 能力**(配置了 MCP server 时可用)
223
+
224
+ | 工具 | 说明 |
225
+ |------|------|
226
+ | `mcp_search` / `mcp_describe` / `mcp_call` | 通过共享 capability runtime 发现并调用 MCP 工具 |
227
+ | `mcp_read_resource` / `mcp_get_prompt` | 读取 MCP 资源、获取 MCP prompt |
228
+
229
+ **Git Worktree**
230
+
231
+ | 工具 | 说明 |
232
+ |------|------|
233
+ | `worktree_create` | 在隔离分支上新建 worktree,让 agent 安全工作 |
234
+ | `worktree_remove` | 移除 worktree(自带安全检查) |
235
+
236
+ **Agent 控制 / 交互**
237
+
238
+ | 工具 | 说明 |
239
+ |------|------|
240
+ | `dispatch_child_task` | 派发子 agent 跑独立调研 / 改动任务 |
241
+ | `ask_user_question` | 向用户发起单选 / 多选 / 自由文本提问 |
242
+ | `exit_plan_mode` | Plan 模式下提交最终方案给用户审批(仅 REPL) |
243
+ | `emit_managed_protocol` | scout / planner / handoff / verdict 内部协议侧信道 |
244
+
245
+ ## Repo Intelligence Premium
246
+
247
+ KodaX 现在支持一套拆分后的 Repo Intelligence 架构:
248
+
249
+ - 公共 OSS baseline 在 public `KodaX` 仓库里
250
+ - premium intelligence 在 private `KodaX-private` 仓库里
251
+ - premium 通过本地 `repointel` frontdoor 和 daemon 运行
252
+ - KodaX 自身支持原生旗舰路径
253
+
254
+ 一句话理解:
255
+
256
+ - 没有 premium 时,KodaX 仍然能正常工作
257
+ - 安装 premium 后,KodaX 可以获得更强的仓库理解、影响面分析、上下文压缩和原生自动注入能力
258
+
259
+ ## Repo Intelligence 运行模式
260
+
261
+ KodaX 支持这些模式:
262
+
263
+ - `off`
264
+ - 严格关闭 repo-intelligence 工作面
265
+ - 不自动注入,也不暴露 repo working tools
266
+ - 但 `/repointel` 控制命令仍然保留
267
+ - `oss`
268
+ - 只使用 public OSS baseline
269
+ - `premium-shared`
270
+ - 使用 premium,但不走 KodaX 原生 auto lane
271
+ - 适合和其他宿主路径做对比
272
+ - `premium-native`
273
+ - 使用 premium,并走 KodaX 原生路径
274
+ - 这是推荐模式,也是最佳体验
275
+ - `auto`
276
+ - 先尝试 `premium-native`
277
+ - premium 不可用时自动回退到 `oss`
278
+
279
+ ## native-first 使用方式
280
+
281
+ 当前正式发布推荐使用 native `repointel` 包。
282
+
283
+ 也就是说:
284
+
285
+ - 正式 GitHub Release 应该发布 native 包
286
+ - offline bundle 只保留给内部验证或特殊场景
287
+
288
+ ### 普通用户最简配置
289
+
290
+ 如果 `repointel` 已经在 `PATH`:
291
+
292
+ ```json
293
+ {
294
+ "repoIntelligenceMode": "premium-native"
295
+ }
296
+ ```
297
+
298
+ ### 不在 PATH 时
299
+
300
+ ```json
301
+ {
302
+ "repoIntelligenceMode": "premium-native",
303
+ "repointelBin": "C:\\Tools\\repointel\\repointel.exe"
304
+ }
305
+ ```
306
+
307
+ ### 作者同父目录联调
308
+
309
+ ```json
310
+ {
311
+ "repoIntelligenceMode": "premium-native",
312
+ "repointelEndpoint": "http://127.0.0.1:47891",
313
+ "repointelBin": "C:\\path\\to\\KodaX-private\\packages\\repointel-cli\\dist\\index.js",
314
+ "repoIntelligenceTrace": true
315
+ }
316
+ ```
317
+
318
+ 配置模板可参考:
319
+
320
+ - [config.example.jsonc](./config.example.jsonc)
321
+
322
+ ## `repointelEndpoint` 是什么
323
+
324
+ `repointelEndpoint` 表示 KodaX 连接本地 premium daemon 的地址。
325
+
326
+ 默认值通常是:
327
+
328
+ ```json
329
+ "repointelEndpoint": "http://127.0.0.1:47891"
330
+ ```
331
+
332
+ 大多数用户不需要手动配置它,只有这些情况才建议显式设置:
333
+
334
+ - 你改了默认端口
335
+ - 你想同时跑多个 daemon
336
+ - 你在做本地调试或隔离实验
337
+
338
+ ## REPL 里怎么看当前状态
339
+
340
+ 启动 `kodax` 后,可以直接使用:
341
+
342
+ - `/status`
343
+ - 看简要状态
344
+ - `/repointel`
345
+ - 看更详细的 repo-intelligence 状态
346
+ - `/repointel status`
347
+ - 显式探测本地 premium frontdoor
348
+
349
+ 最重要的字段有:
350
+
351
+ - `mode`
352
+ - `engine`
353
+ - `bridge`
354
+ - `status`
355
+
356
+ 例如:
357
+
358
+ - `premium-native / premium / native / ok`
359
+ - 说明 premium 生效了,而且走的是 KodaX 原生旗舰路径
360
+ - `oss / oss / none / ok`
361
+ - 说明当前实际运行在 OSS baseline
362
+
363
+ ## REPL 里怎么控制 Repo Intelligence
364
+
365
+ 可用命令包括:
366
+
367
+ - `/repointel`
368
+ - `/repointel status`
369
+ - `/repointel mode premium-native|premium-shared|oss|off|auto`
370
+ - `/repointel trace on|off|toggle`
371
+ - `/repointel warm`
372
+ - `/repointel endpoint ...`
373
+ - `/repointel bin ...`
374
+
375
+ 你也可以用:
376
+
377
+ - `/clear`
378
+
379
+ 来清空当前会话上下文。
380
+
381
+ 如果要做严格 benchmark,最好每档模式都使用一个全新的 session,避免旧上下文污染结果。
382
+
383
+ ## `repoIntelligenceTrace` 有什么用
384
+
385
+ `repoIntelligenceTrace` 是一个诊断和对比开关。
386
+
387
+ 打开后,你可以更清楚地看到:
388
+
389
+ - 当前到底是 `oss` 还是 `premium`
390
+ - 当前是 `shared` 还是 `native`
391
+ - daemon latency
392
+ - cache hit/miss
393
+ - capsule token 估算
394
+
395
+ 普通用户平时通常可以不开;联调、benchmark、排障时再打开。
396
+
397
+ ## `premium-native` 和 `premium-shared` 的区别
398
+
399
+ 两者都使用 premium,但区别在于是否使用 KodaX 原生特权路径:
400
+
401
+ - `premium-native`
402
+ - KodaX 旗舰路径
403
+ - 更早预取 intelligence
404
+ - 在 planning / routing / prompt build 前就更主动地使用 premium
405
+ - `premium-shared`
406
+ - 仍然用 premium
407
+ - 但故意不走 KodaX 原生 auto lane
408
+ - 更接近其他宿主的共享接入方式
409
+
410
+ 如果你平时自己用 KodaX,推荐 `premium-native`。
411
+
412
+ ## 如何更明显地体现 `repointel` 收益
413
+
414
+ 最容易体现 repo-intelligence 收益的任务,不是“改单一文件”,而是:
415
+
416
+ - 需要先理解仓库结构
417
+ - 需要缩小范围
418
+ - 需要判断模块、流程、影响面
419
+
420
+ 例如:
421
+
422
+ ```text
423
+ 我要给 KodaX 增加一个真正的 /new 命令。先不要写代码,先判断最可能需要改哪些模块、调用链会经过哪里、最值得先看的 8 个文件是什么。
424
+ ```
425
+
426
+ ```text
427
+ 帮我定位 KodaX 从命令行启动,到进入 REPL 或 ACP,再到真正调用 coding agent 的主入口链。先给我分层图和最关键文件,不要先铺开全部实现。
428
+ ```
429
+
430
+ 如果你要做 A/B 测试,建议比较:
431
+
432
+ - `off`
433
+ - `oss`
434
+ - `premium-shared`
435
+ - `premium-native`
436
+
437
+ 而且每档尽量用全新的 session。
438
+
439
+ ## Clients 目录说明
440
+
441
+ `clients/` 目录现在已经收敛成极简结构。
442
+
443
+ 它只保留一个共享的开放资产:
444
+
445
+ - `clients/repointel/`
446
+
447
+ 这份 shared skill 是 Phase 1 多宿主接入的唯一源:
448
+
449
+ - Codex
450
+ - Claude Code
451
+ - OpenCode
452
+
453
+ 都通过同一份 shared skill 接入本地 `repointel`,而不是各自维护一套 host-pack 目录。
454
+
455
+ 这样做的原因是:
456
+
457
+ - premium 逻辑在 `KodaX-private` 的 `repointel` 工具里,不在 host 包装层里
458
+ - 多宿主接入本来就是薄层,不应该继续保留一堆 Windows-first 的历史壳目录
459
+ - 共享一个 skill 源更干净、更容易维护,也更符合当前 native-first 的发布方向
460
+
461
+ 现在的标准使用方式是:
462
+
463
+ - 用 `clients/repointel/scripts/install.mjs` 把 shared skill 安装到目标宿主需要的位置
464
+ - 用 `clients/repointel/scripts/doctor.mjs` 检查本地 premium / daemon / host skill 安装状态
465
+ - 用 `clients/repointel/scripts/demo.mjs` 做本地演示和验证
466
+
467
+ 示例:
468
+
469
+ ```powershell
470
+ node .\clients\repointel\scripts\install.mjs --host codex
471
+ node .\clients\repointel\scripts\install.mjs --host claude --workspace-root C:\path\to\workspace
472
+ node .\clients\repointel\scripts\install.mjs --host opencode --workspace-root C:\path\to\workspace
473
+ ```
474
+
475
+ 补充说明:
476
+
477
+ - 可安装的 skill 目录入口是 `clients/repointel/SKILL.md`
478
+ - `clients/repointel/` 整个目录遵循 Claude Code Skills 规范,`SKILL.md` 是入口,`reference.md` 是辅助参考文件
479
+ - `scripts/install.mjs`、`doctor.mjs`、`demo.mjs` 是仓库维护脚本,位于 `scripts/` 子目录
480
+ - 所以 `clients/repointel/` 现在承载的是完整的第三方宿主集成单元,而不只是一个单独的 skill 文件
481
+
482
+ 也就是说:
483
+
484
+ - `clients/` 不是 build 产物
485
+ - 它现在也不再是“每个宿主一套安装包”
486
+ - 它只是存放 shared repointel skill 的正式源码位置
487
+
488
+ ## 仓库结构
489
+
490
+ KodaX 是一个基于 npm workspaces 的 TypeScript monorepo。核心包:
491
+
492
+ | 包 | 作用 | 主要依赖 |
493
+ |----|------|---------|
494
+ | `@kodax/ai` | LLM 抽象层(12 个内置 provider + 自定义 provider 注册),可独立使用 | `@anthropic-ai/sdk`, `openai` |
495
+ | `@kodax/agent` | 通用 Agent 框架,会话管理 + tokenization + 可插拔 compaction policy | `@kodax/ai`, `js-tiktoken` |
496
+ | `@kodax/skills` | Agent Skills 标准实现(自然语言触发、变量解析) | 零外部依赖 |
497
+ | `@kodax/coding` | Coding Agent:30+ 工具、prompts、agent loop、auto-continue | `@kodax/ai`, `@kodax/agent`, `@kodax/skills` |
498
+ | `@kodax/repl` | 完整交互式终端 UI(Ink / React、权限模式、命令系统、流式渲染) | `@kodax/coding`, `ink`, `react` |
499
+
500
+ 根目录 `src/kodax_cli.ts` 是 CLI 入口;构建产物在 `dist/`,单文件二进制在 `dist/binary/<target>/`。
501
+
502
+ ```
503
+ KodaX/
504
+ ├── packages/
505
+ │ ├── ai/ # @kodax/ai
506
+ │ │ └── providers/ # 12 个 LLM provider 实现
507
+ │ ├── agent/ # @kodax/agent(session + token)
508
+ │ ├── skills/ # @kodax/skills
509
+ │ │ └── builtin/ # 内置 skills:code-review / tdd / git-workflow / skill-creator
510
+ │ ├── coding/ # @kodax/coding(tools + prompts)
511
+ │ │ └── tools/ # read/write/edit/bash/grep/repo-intel/MCP/worktree/...
512
+ │ └── repl/ # @kodax/repl(Ink TUI)
513
+ ├── src/
514
+ │ └── kodax_cli.ts # CLI 主入口
515
+ ├── scripts/
516
+ │ └── build-binary.mjs # Bun --compile 单文件二进制打包脚本
517
+ └── .github/workflows/
518
+ └── release.yml # 推 v* tag 自动发布 GitHub Release
519
+ ```
520
+
521
+ 这套拆分让你既可以把 KodaX 当成完整产品使用,也可以只复用其中某一层能力。
522
+ ## API 导出
523
+
524
+ ```typescript
525
+ // 主函数
526
+ export { runKodaX, KodaXClient };
527
+
528
+ // 类型
529
+ export type {
530
+ KodaXEvents, KodaXOptions, KodaXResult,
531
+ KodaXMessage, KodaXContentBlock,
532
+ KodaXSessionStorage, KodaXToolDefinition
533
+ };
534
+
535
+ // 工具
536
+ export { KODAX_TOOLS, KODAX_TOOL_REQUIRED_PARAMS, executeTool };
537
+
538
+ // Provider
539
+ export { getProvider, KODAX_PROVIDERS, KodaXBaseProvider };
540
+
541
+ // 工具函数
542
+ export {
543
+ estimateTokens,
544
+ getGitRoot, getGitContext, getEnvContext, getProjectSnapshot,
545
+ checkPromiseSignal
546
+ };
547
+ ```
548
+
549
+ ---
550
+
551
+ ## 术语说明
552
+
553
+ | 术语 | 含义 | 位置 |
554
+ |------|------|------|
555
+ | **Skills** | Agent 能力(KODAX_TOOLS: read, write, bash 等)+ 扩展 Skills | Coding 层 + Skills 层 |
556
+ | **Commands** | CLI 快捷命令(/review, /test 等) | REPL 层 |
557
+
558
+ ---
559
+
560
+ ## 开发
561
+
562
+ ```bash
563
+ # 开发模式
564
+ npm run dev "你的任务"
565
+
566
+ # 构建
567
+ npm run build
568
+
569
+ # 可选:只构建 workspace packages
570
+ npm run build:packages
571
+
572
+ # 打包成单文件二进制(当前平台 / 全平台)
573
+ npm run build:binary
574
+ npm run build:binary:all
575
+
576
+ # 测试
577
+ npm test
578
+
579
+ # Eval-driven development(provider 矩阵、identity round-trip 等)
580
+ npm run test:eval
581
+
582
+ # 清理
583
+ npm run clean
584
+ ```
585
+
586
+ ### Repo Intelligence 缓存目录
587
+
588
+ KodaX 现在会把 Repo Intelligence 的本地缓存分成两条路径:
589
+
590
+ - `.agent/repo-intelligence/`
591
+ - OSS baseline 的索引、缓存和现有 task-engine 产物。
592
+ - `.repointel/`
593
+ - premium `repointel` 的 workspace 级共享缓存,供本地 daemon / native frontdoor 使用。
594
+
595
+ 这样拆开的目的很明确:
596
+
597
+ - premium 不可用时,OSS fallback 仍然可以稳定工作。
598
+ - premium 缓存不会污染 OSS 产物目录。
599
+ - KodaX 和其他宿主可以共享同一份 premium workspace cache。
600
+
601
+ `.repointel/` 是本地生成目录,不应该提交到 Git。
602
+
603
+ ---
604
+
605
+ ## 文档
606
+
607
+ - [README.md](README.md) - 英文版 README
608
+ - [docs/release.md](docs/release.md) - 单文件二进制构建与发布流程
609
+ - [docs/PRD.md](docs/PRD.md) - 产品需求
610
+ - [docs/ADR.md](docs/ADR.md) - 架构决策
611
+ - [docs/HLD.md](docs/HLD.md) - 高层设计
612
+ - [docs/DD.md](docs/DD.md) - 详细设计
613
+ - [docs/FEATURE_LIST.md](docs/FEATURE_LIST.md) - Feature 跟踪
614
+ - [docs/test-guides/](docs/test-guides/) - 功能专用测试指南
615
+ - [CHANGELOG.md](CHANGELOG.md) - 更新日志(v0.7.0+;更早版本见 [CHANGELOG_ARCHIVE](docs/CHANGELOG_ARCHIVE.md))
616
+
617
+
618
+ ---
619
+
620
+ ## 许可证
621
+
622
+ 公共仓库当前采用:
623
+
624
+ - `Apache-2.0`
625
+
626
+ ## 相关仓库
627
+
628
+ 建议把公仓和私仓 clone 到同一个父目录下,例如:
629
+
630
+ - public repo: `<parent>/KodaX`
631
+ - private repo: `<parent>/KodaX-private`(未公开发布)
@@ -0,0 +1,63 @@
1
+ ---
2
+ name: code-review
3
+ description: 审查代码、diff、提交或当前 git 改动,重点发现 bug、行为回归、边界条件遗漏、安全风险、性能问题和缺失测试。当用户提到 code review、review 这段代码、帮我看看改动有没有问题、审查 PR/提交时使用;不要用于单纯解释代码或直接实现需求。
4
+ user-invocable: true
5
+ allowed-tools: "Read, Grep, Glob, Bash(npm:*, node:*, npx:*)"
6
+ argument-hint: "[file-or-directory]"
7
+ compatibility: "Works best in a git repository or when the review target is provided explicitly."
8
+ ---
9
+
10
+ # Code Review Skill
11
+
12
+ 对 **$ARGUMENTS** 进行代码审查,并优先输出真正会影响正确性、稳定性或可维护性的发现。
13
+
14
+ ## 范围判定
15
+
16
+ - 如果提供了 `$ARGUMENTS`,审查对应文件、目录、diff 或提交范围。
17
+ - 如果没有提供参数,优先审查当前 git 改动;如果不在 git 仓库中,就明确说明缺少范围并请求更具体的目标。
18
+ - 在下结论前,尽量查看相邻实现、调用方、测试和相关配置,避免脱离上下文的误报。
19
+
20
+ ## 审查重点
21
+
22
+ - 正确性与回归风险:逻辑错误、边界条件、状态同步、类型假设、兼容性变化。
23
+ - 稳定性与安全性:异常处理、输入校验、资源泄漏、敏感信息暴露、权限或注入风险。
24
+ - 性能与可维护性:明显的复杂度问题、重复逻辑、难以验证的实现、缺失测试保护。
25
+ - 只报告有行动价值的问题。纯风格偏好或可选优化,不要包装成高优先级 finding。
26
+
27
+ ## 严重级别
28
+
29
+ - `Critical`: 会导致数据丢失、严重安全问题、崩溃或明显错误结果。
30
+ - `High`: 很可能引发实际 bug、行为回归或线上风险。
31
+ - `Medium`: 不是立刻出错,但会留下明显缺陷、维护风险或测试空洞。
32
+ - `Low`: 小范围问题或局部改进点,仅在确实值得用户处理时报告。
33
+
34
+ ## 输出要求
35
+
36
+ - 先给 `## Findings`,并按严重级别从高到低排列。
37
+ - 每条 finding 都要包含:
38
+ - 严重级别和简短标题
39
+ - 具体文件和行号
40
+ - 为什么这是问题,可能造成什么影响
41
+ - 建议的修复方向
42
+ - 如果没有发现值得报告的问题,明确写 `No findings.`,然后补充剩余风险或测试空白。
43
+ - 需要时再追加 `## Open Questions` 或 `## Change Summary`,但不要用总体打分或“亮点”冲淡问题。
44
+
45
+ ## 输出模板
46
+
47
+ ```markdown
48
+ ## Findings
49
+ - [High] Title — `path/to/file.ts:42`
50
+ Why it matters and what to change.
51
+
52
+ ## Open Questions
53
+ - Optional clarification or assumption.
54
+
55
+ ## Change Summary
56
+ - Optional short summary only after findings.
57
+ ```
58
+
59
+ ## 使用示例
60
+
61
+ - `/code-review src/auth.ts` - 审查单个文件
62
+ - `/code-review packages/core/src/` - 审查目录
63
+ - `/code-review` - 审查当前 git 变更