@whatevertogo/oh-my-kimicli
v0.1.4
Published
Personal workflow orchestration for Kimi Code CLI: skills, hooks, persistent continuation, review gates, and usage insights.
Downloads
50
Maintainers
Readme
oh-my-kimicli
面向 Kimi Code CLI 的外置增强包:安装 skills、hooks、提示词模板和一个 omk 辅助命令,让 KimiCLI 更适合长期、可复盘、可沉淀的工程协作。
oh-my-kimicli 的重点不是替代 KimiCLI,而是在 KimiCLI 原生能力外加一层可维护的个人工作流:
- 用
/skill:insights从真实 session 里复盘你的使用模式 - 用
/skill:omk-ralph和 hook 让任务能持续到完成或明确阻塞 - 用
/skill:ultrawork把复杂任务编排成 plan、执行、验证、审查的闭环 - 用
/skill:omk-review在提交前做聚焦审查 - 用 requirements / clarify skills 降低“没问清就做错”的成本
当前状态
- 发布包名:
@whatevertogo/oh-my-kimicli。 - KimiCLI 集成方式:写入
~/.kimi/skills,并在~/.kimi/config.toml中注册 hooks。 - 项目级状态:Ralph/Ultrawork 状态写入当前工作目录的
./.omk/state/。 - 用户级配置:
~/.omk/config.json。
安装
推荐使用 npm 安装:
npm install -g @whatevertogo/oh-my-kimicli
omk setup如果你明确想用 Bun 管理全局包,也可以使用:
bun install -g @whatevertogo/oh-my-kimicli
omk setup不要使用:
bun install -g oh-my-kimicli未 scoped 的 oh-my-kimicli 会被 npm 包名相似度保护拦截;请使用 scoped 包名。
安装后可以检查:
omk doctor需要安装开发版时,可以从 GitHub 安装:
bun install -g github:whatevertogo/oh-my-kimicli
omk setup更新
推荐使用:
omk updateomk update 默认使用 npm 更新已发布包,并刷新托管 skills/hooks:
npm uninstall -g oh-my-kimicli
npm uninstall -g @whatevertogo/oh-my-kimicli
npm install -g @whatevertogo/oh-my-kimicli
omk setup --forcesetup --force 只处理明确带有 OMK marker 且未被用户修改的同名托管 skills,不会覆盖其它用户 skill,也不会覆盖你手改过的托管 skill。对于允许被替换的托管 skill,旧目录会先备份到:
~/.kimi/skills/.omk-backups/<timestamp>/为什么不继续默认使用 Bun?
Bun 仍是本项目推荐的开发工具链,但 npm 包面向普通 KimiCLI 用户,默认不要求额外安装 Bun。需要 Bun 管理全局包时可以显式使用 omk update --manager bun。
Windows 上,omk update 默认会把更新脚本排到当前 omk.exe 退出后运行,避免正在运行的二进制被删除失败。日志写入:
~/.omk/update.log可用选项:
omk update --dry-run # 只显示将执行的步骤
omk update --target github:owner/repo#branch
omk update --manager bun # 使用 Bun 管理全局包
omk update --no-setup # 只更新全局包,不刷新 KimiCLI 安装如果你当前安装的版本还没有 omk update,第一次仍需手动执行:
npm uninstall -g oh-my-kimicli
npm uninstall -g @whatevertogo/oh-my-kimicli
npm install -g @whatevertogo/oh-my-kimicli
omk setup --force命令
omk setup # 安装插件、skills、prompts 和 hooks
omk setup --force # 备份后刷新同名托管 skills
omk update # 重新安装 npm latest 并刷新 setup
omk uninstall # 移除托管 hooks、插件和 skills
omk status # 查看当前项目 .omk 工作流状态
omk cancel # 将当前项目 Ralph 工作流标记为 blocked
omk resume # 将当前项目 Ralph 工作流重新标记为 active
omk clean # 删除当前项目 .omk/state 工作流状态
omk config # 创建或规范化 ~/.omk/config.json
omk doctor # 输出机器可读的安装诊断信息
omk review-target # 输出当前代码审查目标 JSON
omk insights prepare # 生成 /skill:insights 使用的 evidence pack
omk insights render # 从 insights-content.json 渲染 HTML/JSON 报告
omk insights paths # 打印 insights 产物路径
omk help # 显示帮助omk hook 是内部 hook 入口,由 omk setup 注册,不作为公开命令使用。
Skills
omk setup 会把 6 个 skill 安装到 ~/.kimi/skills。在 KimiCLI 中通过 /skill:<name> 调用。
/skill:insights — 使用洞察报告
从 KimiCLI session 历史中生成个人使用洞察。它不是快速统计页,而是一条 Claude Code style 的两段式管线:
/skill:insights
-> omk insights prepare
-> 当前 Kimi agent 阅读 evidence-pack.md
-> 当前 Kimi agent 写 insights-content.json
-> omk insights render
-> 生成 report.html / report.json产物目录:
~/.omk/usage-data/insights/
├── evidence-pack.md
├── evidence-pack.json
├── insights-content.schema.json
├── insights-content.json
├── report.html
└── report.json报告关注:
- 你常做的项目和任务类型
- 与 KimiCLI 协作时的有效模式
- 工具失败、反复纠正、任务中断等摩擦点
- 重复出现的用户偏好和指令
- 哪些工作流值得沉淀为 skill、hook 或 AGENTS.md 规则
设计边界:
- 不嵌套启动
kimi --print - 不让外部 CLI 自己调用模型
- 不保留快速统计页
- 叙事内容必须来自 evidence pack 和当前 Kimi agent 的分析
/skill:omk-ralph — 持久化续接循环
让 KimiCLI 在任务完成、明确阻塞或达到最大迭代前持续工作。
核心状态文件:
./.omk/state/ralph-state.json基本状态:
{
"workflow": "ralph",
"status": "active",
"completion_promise": "OMK_RALPH_DONE",
"iteration": 0,
"max_iterations": -1,
"evidence": []
}行为:
active:Stop hook 阻止结束,并注入prompts/ralph/continue.mddone:Stop hook 注入一次prompts/ralph/end.md让 agent 总结,然后允许停止blocked:需要用户输入、凭据、批准或破坏性操作时允许停止
这套 Ralph 是 oh-my-kimicli 的 hook/state 实现,不依赖 KimiCLI 原生 Ralph。
/skill:ultrawork — 大任务自动执行
用于多步骤、跨文件、需要验证的大任务。它会要求 agent 进入更严格的执行纪律:
- 大任务先使用 KimiCLI 原生 plan mode 形成计划
- 选择当前任务需要的 skills,而不是盲目套用全部 skill
- 必须启用 OMK Ralph 状态,避免未完成就停止
- 执行时持续记录证据
- 完成前运行合适的验证
- 收尾时使用
omk-review做质量门禁
适合:
- 多文件功能实现
- 系统性修复
- 复杂 refactor
- 长代码审查
- “请你一直做完”的任务
/skill:omk-review — 聚焦代码审查
生成代码审查报告:
./.omk/CODE_REVIEW_ISSUES.md审查范围优先级:
用户指定范围 > staged diff > working-tree diff > branch diff四个视角:
- Security:真实可利用的注入、密钥、权限绕过、不安全反序列化
- Code Quality:会导致错误输出、崩溃或误导维护者的问题
- Tests:变更行为缺失的测试、失效测试、无效断言
- Architecture:跨层接口不一致、类型未传播、公共 API 变更遗漏
它会尽量过滤噪声,只报告能站得住的真实问题,并区分新问题、已有问题和低置信度观察。
/skill:requirements-elicitation — 执行前需求澄清
当用户的目标、范围、约束或验收标准不清晰时使用。它处理的是“做什么”。
模式:
- Light:错误成本低,快速复述确认
- Standard:一次性收拢关键问题
- Deep:多轮挖掘,输出需求文档
原则:
- 只问影响结果的问题
- 能从仓库或上下文推断的不问
- 用户说“直接做/你决定”时停止追问,基于合理假设开始
/skill:clarify-first — 执行中决策确认
当执行过程中遇到高影响实现选择时使用。它处理的是“怎么做”。
触发条件:
- 有具体实现决策
- 至少两个合理方案
- 选择会影响行为、数据、兼容性、成本或安全
它会给出推荐方案和理由,而不是机械地把所有小事都丢回给用户。
Hook 系统
omk setup 会向 KimiCLI 的 config.toml 注册这些 hook:
UserPromptSubmitPreToolUsePostToolUseStopSubagentStopStopFailure
当前主要用途:
- Ralph 状态初始化和续接
- Ultrawork/Ralph 停止门禁
- Plan mode 下一轮提示注入
- 危险 shell 命令的防御性拦截
- workflow 状态和事件日志维护
Plan 模式提示
可编辑文件:
prompts/plan/enter-plan-mode-next-turn.md
prompts/plan/plan-template.md
prompts/plan/plan-mode-reentry.md当前策略:
- 保留 KimiCLI 原生 plan mode
- 只在检测到
plan_mode=true后注入下一轮提示 - 不 hook
ExitPlanMode - 在 plan mode 内提醒 agent 用子智能体或自审方式检查 plan
配置
用户级配置文件:
~/.omk/config.json默认内容:
{
"version": 1,
"privacy": {
"record_hook_prompts": false,
"record_cwd": true,
"redact_secrets": true,
"redact_paths": false
},
"safety": {
"block_destructive_shell": true,
"warn_cleanup_dirs": true
},
"features": {
"pet": false
}
}默认不把 hook prompt 写入事件日志,并会对常见密钥形态做脱敏。features.pet 当前默认关闭,是未来能力的预留开关。测试或隔离运行时可用 OMK_HOME 改变 ~/.omk 位置。
卸载
omk uninstall会移除 oh-my-kimicli 托管的 hooks、plugin 和 skills。它不会删除你的 ~/.omk/usage-data,也不会删除项目内的 ./.omk 状态目录。
卸载只以 OMK marker 判断 skill 是否归 oh-my-kimicli 管理;没有 marker 的同名用户 skill 不会被删除。带 marker 但被你修改过的托管 skill 会先备份到 ~/.kimi/skills/.omk-backups/<timestamp>/,再从 KimiCLI 的 active skills 里移除。
如果要移除全局 CLI:
npm uninstall -g oh-my-kimicli
npm uninstall -g @whatevertogo/oh-my-kimicli本地开发
bun install
bun test
bun run build
bun run check
bun run pack:all本地链接:
bun link
omk setup --force打包产物:
dist/npm/whatevertogo-oh-my-kimicli-0.1.4.tgz
dist/bun/whatevertogo-oh-my-kimicli-0.1.4.tgz
dist/bin/omk.js
dist/bundle/omk.jsnpm 包的 bin 指向 dist/bin/omk.js,这是给用户运行的 Node.js 产物。仓库仍保留 TypeScript 源码以及 skills/、prompts/、plugin/ 目录,因为 omk setup 需要这些资源来安装 KimiCLI 托管文件。
路径速查
~/.kimi/skills/ # KimiCLI 用户 skills
~/.kimi/plugins/oh-my-kimicli/ # 安装后的插件目录
~/.kimi/config.toml # hook 注册位置
~/.omk/config.json # OMK 用户配置
~/.omk/usage-data/insights/ # insights 报告产物
./.omk/state/ralph-state.json # 项目级 Ralph 状态
./.omk/CODE_REVIEW_ISSUES.md # omk-review 报告KimiCLI 当前从 ~/.kimi/skills 发现用户 skill,因此 oh-my-kimicli 始终把托管 skill 写入该目录,即使设置了 KIMI_SHARE_DIR。
