oh-my-claude

agent
Security Audit
Fail
Health Warn
  • License — License: MIT
  • Description — Repository has a description
  • Active repo — Last push 0 days ago
  • Low visibility — Only 6 GitHub stars
Code Fail
  • fs module — File system access in .github/workflows/ci-cd.yml
  • rm -rf — Recursive force deletion command in examples/custom-hook/my-custom-hook.sh
Permissions Pass
  • Permissions — No dangerous permissions requested
Purpose
This is a Claude Code orchestration plugin inspired by Chinese traditional culture. It provides a specialized agent system where each agent is named after a historical Chinese figure and is responsible for tasks like code review, security auditing, and DevOps.

Security Assessment
The scan identified a FAIL for recursive force deletion (`rm -rf`) inside an example custom hook script (`my-custom-hook.sh`). While this is in an examples directory, it is a dangerous command pattern that users might copy directly into their workflows. There is also file system access inside the CI/CD GitHub Actions workflow, which is typical for build pipelines but worth noting. No dangerous permissions are requested and no hardcoded secrets were found. There is no evidence of unauthorized network requests or sensitive data harvesting. Overall risk is rated Medium due to the destructive shell command pattern and the fact that the tool is primarily Shell-based, meaning it has direct system-level execution capabilities.

Quality Assessment
The project is very new and has low visibility, with only 6 GitHub stars. However, it is actively maintained (last push was today) and uses the permissive MIT license. The README is extensive and well-documented, featuring a modern TypeScript stack with a modular agent architecture. Community trust is currently low simply due to the project's age and limited adoption. There is not enough user feedback or track record yet to assess real-world reliability.

Verdict
Use with caution. The tool shows thoughtful design and clean licensing, but its minimal community adoption and the presence of an `rm -rf` command in example files mean you should review the shell scripts carefully before integrating it into any production or sensitive environment.
SUMMARY

基于中国传统文化的 Claude Code 智能编排插件 🏔️ A Claude Code plugin inspired by Chinese traditional culture

README.md

oh-my-claude 🏔️

npm version
License: MIT
Claude Code
PRs Welcome
中文
English

基于中国传统文化的 Claude Code 智能编排插件

太行、王屋二山,方七百里,高万仞。
北山愚公者,年且九十,面山而居...
虽我之死,有子存焉;子又生孙,孙又生子;
子子孙孙无穷匮也,而山不加增,何苦而不平?

                                    —— 《列子·汤问》

🌟 项目理念

致敬 oh-my-opencode

本项目灵感来源于 oh-my-opencode,一个优秀的 Claude Code 插件生态项目。我们在学习借鉴的基础上,融入中国传统文化元素,打造了这个具有东方特色的版本。

愚公精神

子子孙孙无穷匮也,而山不加增,何苦而不平?

oh-my-claude 的核心理念源自「愚公移山」的精神:只要方向正确,坚持就会成功。

  • 🏔️ 持续执行 - 任务未完成,绝不停止
  • 🎯 目标导向 - 分解大任务,逐个击破
  • 💪 永不放弃 - 遇到问题,调整策略继续前进

✨ 特性

🔷 现代化技术栈

  • 完整 TypeScript 迁移 - 提供类型安全和现代开发体验
  • 模块化架构 - 职责分离,支持扩展和维护
  • 智能配置系统 - 分层配置、热重载、环境变量支持

🎭 智能 Agent 体系

基于中国传统文化人物的专业化 Agent:

Agent 名称 专长 命令 英文别名
🏔️ 愚公 (YuGong) 主编排,大规模任务 /yugong /yishan
🎯 诸葛 (ZhuGe) 战略顾问,架构设计 /zhuge /longzhong /arch
🔧 鲁班 (LuBan) 精工巧匠,代码实现 /luban /qiaogong
🔍 悟空 (WuKong) 代码侦察,快速探索 /wukong /huoyan /explore
🩺 扁鹊 (BianQue) Bug 诊断,问题修复 /bianque /wangwen
🛡️ 墨子 (MoZi) 安全审计,防御编程 /mozi /security /secure
⚔️ 孙子 (SunZi) 性能优化,系统调优 /sunzi /perf
📜 司马迁 (SimaQian) 文档撰写,变更记录 /simaqian /doc
郑和 (ZhengHe) API 集成,外部服务 /zhenghe /api
🔭 张衡 (ZhangHeng) 系统监控,可观测性 /zhangheng /monitor
🌊 李冰 (LiBing) DevOps,基础设施 /libing /devops
☯️ 老子 (LaoZi) 代码简化,Clean Code /laozi /simplify
⚖️ 包拯 (BaoZheng) 测试专家,TDD /baozheng /test
🪞 魏征 (WeiZheng) 代码审查,规范检查 /weizheng /review
📊 仓颉 (CangJie) 数据库设计,SQL 优化 /cangjie /db
李白 (LiBai) 需求分析,用户故事 /libai /poet
🎨 顾恺之 (GuKaiZhi) UI/UX 设计,界面美学 /gukaizhi /painter
🌙 嫦娥 (ChangE) 云服务,DevOps 部署 /change /cloud
🖼️ 离娄 (LiLou) 多模态分析,图像理解 /lilou /looker
🔮 刘伯温 (LiuBoWen) 计划审查,风险评估 /liubowen /momus
📊 祖冲之 (ZuChongZhi) 数据分析,统计检验 /zuchongzhi /scientist /data
🔍 狄仁杰 (DiRenJie) QA 测试,交互测试 /direnjie /qa-tester /qa
🌊 大禹 (DaYu) 构建修复,CI/CD /dayu /build-fixer /fix-build

🆕 Agent 分层体系 (v2.2.0 新增)

为支持节俭模式,核心 Agent 提供多个版本:

层级 模型 Agent 示例 适用场景
LOW Haiku zhuge-low, luban-low, baozheng-low, bianque-low, gukaizhi-low, mozi-low, cangjie-low, scientist-low, qa-tester-low, build-fixer-low 简单任务、快速响应
MEDIUM Sonnet 所有标准 Agent, wukong-medium 日常开发任务
HIGH Opus wukong-high, luban-high, mozi-high, bianque-high, scientist-high, qa-tester-high 复杂架构、关键决策

💡 节俭模式 (/jiejian) 会根据任务复杂度自动选择合适的 Agent 版本

🔄 愚公移山模式

核心特性:不完成,不罢休

# 启动愚公移山模式
/yishan 重构整个认证模块

# 或使用英文
/ultrawork refactor the entire auth module
  • ✅ 自动任务分解和追踪
  • ✅ Todo 强制执行(未完成不能停止)
  • ✅ 智能错误恢复
  • ✅ 进度透明报告

🆕 四种执行模式 (v2.2.0 新增)

模式 命令 说明 适用场景
超级模式 /chaoji /ultrapilot /up 并行执行,最多 5 倍加速 大型任务、多文件修改
💰 节俭模式 /jiejian /ecomode /eco 智能模型路由,节省 30-50% Token 简单任务、预算敏感
🐝 蜂群模式 /fengqun N:agent /swarm N:agent N 个同类 Agent 协作 批量处理、大规模重构
🏔️ 标准模式 /yishan /ultrawork 单 Agent 顺序执行 默认模式、复杂逻辑
# 超级模式:并行处理,加速执行
/chaoji 重构整个用户模块

# 节俭模式:优先使用低成本模型
/jiejian 修复这个简单的 typo

# 蜂群模式:3 个诸葛 Agent 并行分析架构
/fengqun 3:zhuge 分析整个项目架构

模式选择指南:

  • 🔥 追求速度 → /chaoji (超级模式)
  • 💵 节省成本 → /jiejian (节俭模式)
  • 📦 批量任务 → /fengqun (蜂群模式)
  • 🎯 复杂逻辑 → /yishan (标准模式)

🆕 任务恢复命令 (v2.0 新增)

命令 功能 用途
/retry 重试失败操作 自动恢复最近失败的命令
/skip 跳过阻塞任务 标记任务完成并继续
/rollback 回滚检查点 撤销更改,恢复稳定状态

🆕 核心命令 (v2.0.24 新增)

命令 功能 别名
/session 会话持久化 - 保存/恢复工作进度 /会话 /ses
/context 上下文管理 - 监控使用率、压缩历史 /上下文 /ctx
/parallel 并行执行 - 多 Agent 同时工作 /并行 /prl

🆕 增强功能 (v2.0.25 新增)

命令 功能 别名 (传统文化)
/stats Agent 性能统计分析 /张衡stats
/init 项目模板初始化 /盘古 /开天
/review 多 Agent 代码审查 /审查 /cr
/learn 项目学习生成画像 /孔子 /求学
/debug 交互式调试助手 /调试
/snippet 代码片段库 /蔡伦 /锦囊
/share 团队协作分享 /孔融 /让梨
/refactor 智能重构建议 /重构 /rf
/error 错误知识库 /华佗kb /药方
/voice 语音交互 (实验性) /伯牙 /知音
/pair AI 结对编程 (实验性) /管鲍 /结对
/timeline 代码时间旅行 /太史 /春秋
/agent Agent 创建向导 /女娲 /造物
# 保存当前会话
/session save "重构认证模块"

# 查看上下文使用状态
/context

# 并行执行多个 Agent
/parallel @wukong @mozi @baozheng 分析代码

# 初始化项目配置 (盘古开天)
/init react-typescript

# 学习项目生成画像 (孔子求学)
/learn project

# 代码审查
/review staged

🌐 中英双语支持

所有命令都支持中英文:

# 中文
/愚公 实现用户登录功能
/诸葛 分析这个架构设计
/扁鹊 这个报错怎么解决

# 英文
/persist implement user login
/strategy analyze this architecture
/debug how to fix this error

🪝 智能 Hook 系统

  • Todo 强制执行器:检测未完成任务,阻止过早停止
  • 关键词检测器:自动激活相应模式
  • 33+ 内置 Hooks:上下文管理、错误恢复、会话通知等

🔌 内置 MCP 服务器 (v1.7.0 新增)

安装后自动配置,无需手动设置:

  • Context7 - 官方文档查询
  • Grep.app - GitHub 代码搜索
  • DeepWiki - 开源项目文档
  • WebSearch - 网络搜索

🛠️ 高级工具

  • LSP 工具 - 代码诊断、重命名、定义跳转
  • AST-Grep - 结构化代码搜索和替换
  • Session 工具 - 会话管理、历史搜索
  • Playwright - 浏览器自动化技能

📦 安装

⚠️ 前提条件: 需要先安装 Claude Code。Claude Code 现已切换为原生安装器:

# 安装 Claude Code(如果尚未安装)
claude install
# 或访问 https://docs.anthropic.com/en/docs/claude-code/getting-started

提供多种安装方式,选择最适合你的:

方式一:npm / npx(推荐)

# 使用 npx 直接安装(无需全局安装)
npx claude-pangu install

# 或全局安装后使用
npm install -g claude-pangu
claude-pangu install

# 也可以使用 bun / pnpm
bunx claude-pangu install
pnpm dlx claude-pangu install

💡 包名说明: npm 包名为 claude-pangu(盘古开天辟地),项目名仍为 oh-my-claude

方式二:一键安装

macOS / Linux:

curl -fsSL https://raw.githubusercontent.com/ZDragon17/oh-my-claude/main/scripts/install.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/ZDragon17/oh-my-claude/main/scripts/install.ps1 | iex

方式三:Homebrew (macOS)

# 添加 tap(首次使用)
brew tap ZDragon17/oh-my-claude https://github.com/ZDragon17/oh-my-claude

# 安装
brew install oh-my-claude

# 注册插件
claude plugins install ~/.claude/plugins/oh-my-claude

方式四:Scoop (Windows)

# 添加 bucket(首次使用)
scoop bucket add oh-my-claude https://github.com/ZDragon17/oh-my-claude

# 安装
scoop install oh-my-claude

# 注册插件
claude plugins install $env:USERPROFILE\.claude\plugins\oh-my-claude

方式五:手动安装

# 克隆项目
git clone https://github.com/ZDragon17/oh-my-claude.git

# 进入目录
cd oh-my-claude

# 安装为 Claude Code 插件
claude plugins install .

验证安装

# 在 Claude Code 中输入
/yishan 你好

# 如果看到愚公移山模式的响应,说明安装成功

更新插件

# npm 方式更新(推荐)
npx claude-pangu@latest update

# 或重新运行一键安装脚本(会自动覆盖旧版本)
# macOS / Linux
curl -fsSL https://raw.githubusercontent.com/ZDragon17/oh-my-claude/main/scripts/install.sh | bash

# Windows (PowerShell)
irm https://raw.githubusercontent.com/ZDragon17/oh-my-claude/main/scripts/install.ps1 | iex

⚠️ 重要: 更新后请完全退出并重新启动 Claude Code(仅关闭窗口可能不够)。macOS 使用 Cmd+Q 完全退出,Windows 确保从任务管理器中关闭所有进程。

卸载插件

# npm 方式卸载
npx claude-pangu uninstall

# 或手动删除
# macOS / Linux
rm -rf ~/.claude/commands/{yishan,yugong,zhuge,bianque,luban,wukong}.md  # 等其他命令文件
rm -rf ~/.claude/plugins/oh-my-claude

# Windows (PowerShell)
Remove-Item -Recurse -Force "$env:USERPROFILE\.claude\plugins\oh-my-claude"
# 命令文件需要单独删除

故障排除

如果安装后命令无法使用,请按以下步骤排查:

1. 完全重启 Claude Code

# macOS: 使用 Cmd+Q 完全退出,不只是关闭窗口
# Windows: 确保从任务管理器中关闭所有 Claude 进程

2. 验证文件是否安装成功

# 检查命令文件是否存在
ls ~/.claude/commands/yishan.md

# 查看所有已安装的命令
ls ~/.claude/commands/

3. 清除缓存(macOS 特定问题)

macOS 上存在已知的命令发现 Bug (Issue #13906),清除缓存可能解决问题:

# 清除 Claude Code 缓存
rm ~/.claude.json

# 然后完全重启 Claude Code

4. 检查 /help 输出

在 Claude Code 中输入 /help,查看是否显示 yishanzhuge 等命令。

5. Windows + WSL 环境问题 (v2.2.19 新增)

如果你在 Windows 上使用 Claude Code,且遇到 hooks 执行错误(如 No such file or directory),可能是 WSL 路径不兼容问题:

症状

Stop hook error: /home/xxx/.claude/plugins/oh-my-claude/hooks/xxx.sh: No such file or directory

原因:Windows 的 $HOME 与 WSL 的 $HOME 路径不同。

解决方案

v2.2.19 已自动处理此问题。如果仍有问题,可手动创建符号链接:

# 在 WSL 中执行
mkdir -p ~/.claude/plugins
ln -sf /mnt/c/Users/你的用户名/.claude/plugins/oh-my-claude ~/.claude/plugins/oh-my-claude

🚀 快速开始

🆕 场景化快速开始 (v2.1.12 新增)

不知道从哪开始?试试:

/quickstart

系统会问你想做什么,然后直接引导你开始:

场景 命令 说明
修 Bug /quickstart 1/qs 1 诊断错误、定位问题、修复代码
做功能 /quickstart 2/qs 2 分析需求、设计方案、实现功能
找代码 /quickstart 3/qs 3 探索项目、定位文件、理解结构
审代码 /quickstart 4/qs 4 代码审查、安全检查、质量分析
了解项目 /quickstart 5/qs 5 技术栈分析、架构理解、依赖梳理

🎯 只需要记住一个命令

/do [你想做的事]

系统会自动识别意图,调用最合适的专家。比如:

/do 修复这个报错            → 自动调用扁鹊
/do 找到登录相关代码         → 自动调用悟空
/do review 这段代码         → 自动调用魏征
/do 实现用户注册功能         → 自动调用愚公
/do 优化这个接口性能         → 自动调用孙子

💡 不需要记住 20 个命令/do 会帮你选择。想了解更多?/help --all

⚡ 5 秒速查

场景 直接用 /do 或者直接调用专家
修 Bug /do 修复这个报错 /bianque
找代码 /do 找到认证代码 /wukong
审查代码 /do review 代码 /weizheng
大任务 /do 实现登录功能 /yishan
架构设计 /do 设计用户系统 /zhuge

🎯 3 分钟上手

我想要... 使用 /do 或直接调用
实现一个功能 /do 实现用户登录功能 /yishan
修复一个Bug /do 修复 TypeError: xxx /bianque
审查代码 /do review this code /weizheng
优化性能 /do 优化这个接口 /sunzi
设计架构 /do 设计微服务架构 /zhuge
探索代码 /do 找到认证相关代码 /wukong

1. 愚公移山 - 大规模任务

/yishan 重构整个用户模块,包括:
- 用户注册
- 用户登录
- 密码重置
- 个人资料管理

愚公会自动:

  1. 分解任务为可执行的 TODO
  2. 逐个完成子任务
  3. 遇到问题调整策略继续
  4. 所有任务完成才停止

2. 诸葛顾问 - 架构设计

/zhuge 我们的用户系统应该如何设计?需要考虑:
- 多租户支持
- 权限管理
- 高可用性

诸葛会提供:

  • 架构方案对比
  • 技术选型建议
  • 风险评估
  • 实施路线图

3. 扁鹊诊断 - Bug 修复

/bianque TypeError: Cannot read property 'name' of undefined
  at UserService.getProfile (user.service.ts:42)

扁鹊会进行:

  • 望闻问切诊断
  • 根因分析
  • 修复方案
  • 预防建议

4. 悟空侦察 - 代码探索

/wukong 找到所有处理用户认证的代码

悟空会快速:

  • 定位相关文件
  • 追踪调用链
  • 汇报发现结果

5. 鲁班巧工 - 精密实现

/luban 实现一个带动画效果的 Toast 组件

鲁班会精心:

  • 设计组件结构
  • 实现核心功能
  • 优化代码质量

📁 项目结构

oh-my-claude/
├── .claude-plugin/
│   └── plugin.json           # 插件配置
├── .github/                  # GitHub 配置
│   ├── ISSUE_TEMPLATE/       # Issue 模板
│   └── PULL_REQUEST_TEMPLATE.md
├── agents/                   # Agent 定义 (18 个)
│   ├── yugong.md             # 愚公 - 主编排
│   ├── zhuge.md              # 诸葛 - 战略顾问
│   ├── luban.md              # 鲁班 - 精工巧匠
│   ├── wukong.md             # 悟空 - 代码侦察
│   ├── bianque.md            # 扁鹊 - Bug 诊断
│   ├── mozi.md               # 墨子 - 安全审计
│   ├── sunzi.md              # 孙子 - 性能优化
│   ├── simaqian.md           # 司马迁 - 文档撰写
│   ├── zhenghe.md            # 郑和 - API 集成
│   ├── zhangheng.md          # 张衡 - 系统监控
│   ├── libing.md             # 李冰 - DevOps
│   ├── laozi.md              # 老子 - Clean Code
│   ├── baozheng.md           # 包拯 - 测试专家
│   ├── weizheng.md           # 魏征 - 代码审查
│   └── cangjie.md            # 仓颉 - 数据库设计
├── commands/                 # 斜杠命令
│   ├── yugong.md             # /yugong 愚公模式
│   ├── yishan.md             # /yishan 移山模式
│   ├── team.md               # /team 团队协作
│   ├── progress.md           # /progress 进度面板
│   └── ...                   # 其他 Agent 命令
├── scripts/                  # 安装脚本
│   ├── cli.js                # CLI 命令行工具
│   ├── install.js            # 独立安装脚本
│   ├── uninstall.js          # 独立卸载脚本
│   ├── install.sh            # Bash 一键安装
│   ├── install.ps1           # PowerShell 安装
│   ├── postinstall.js        # npm 安装后脚本
│   └── sync-version.js       # 版本同步工具
├── homebrew/                 # Homebrew 配置
│   └── oh-my-claude.rb       # Homebrew Formula
├── scoop/                    # Scoop 配置
│   └── oh-my-claude.json     # Scoop manifest
├── skills/                   # 技能定义
│   ├── bilingual/            # 双语支持
│   └── progress/             # 进度面板
├── hooks/                    # Hook 脚本
│   ├── hooks.json            # Hook 配置
│   ├── todo-enforcer.sh      # Todo 强制执行
│   ├── keyword-detector.sh   # 关键词检测
│   └── progress-notifier.sh  # 进度通知
├── docs/                     # 文档
│   └── AGENT_PROTOCOL.md     # Agent 协作协议
├── .npmignore                # npm 发布排除配置
├── package.json              # npm 包配置
├── CHANGELOG.md              # 变更日志
├── CONTRIBUTING.md           # 贡献指南
├── TROUBLESHOOTING.md        # 故障排查指南
├── LICENSE                   # MIT 许可证
├── README.md                 # 中文文档
└── README_EN.md              # English documentation

🎯 命令速查

💡 直接使用命令名即可,如 /yishan/zhuge

Agent 命令

命令 功能
/yugong/yishan 启动愚公移山模式
/zhuge 召唤诸葛顾问
/luban 召唤鲁班巧匠
/wukong 召唤悟空侦察
/bianque 召唤扁鹊诊断
/mozi 召唤墨子安全
/sunzi 召唤孙子性能
/simaqian 召唤司马迁史官
/zhenghe 召唤郑和 API
/zhangheng 召唤张衡监控
/libing 召唤李冰 DevOps
/laozi 召唤老子简洁大师
/baozheng 召唤包拯测试专家
/weizheng 召唤魏征代码审查
/cangjie 召唤仓颉数据库专家
/libai 召唤李白需求炼金师
/gukaizhi 召唤顾恺之界面美学师
/change 召唤嫦娥云端仙子
/lilou 召唤离娄多模态分析
/liubowen 召唤刘伯温计划审查

工具命令

命令 功能 英文别名
/quickstart 🆕 场景化快速开始向导 /qs /fast
/do 🚀 极简万能入口(等同 /yishan)
/suggest 🎯 智能命令推荐
/cheatsheet 📋 快速参考卡
/progress 📊 可视化进度面板
/team 🤝 多 Agent 团队协作

执行模式命令 (v2.2.0 新增)

命令 功能 别名
/auto 🤖 智能模式 - 自动识别任务特征选择最佳模式 /smart /zhineng
/chaoji ⚡ 超级模式 - 并行执行,5 倍加速 /ultrapilot /up
/jiejian 💰 节俭模式 - 智能路由,省 Token /ecomode /eco
/fengqun 🐝 蜂群模式 - N 个同类 Agent 协作 /swarm

💡 推荐使用 /auto:无需手动选择模式,系统根据任务描述自动选择最佳执行策略

关键词触发

在任何提示中包含这些关键词会自动激活相应模式:

关键词 触发模式
ultrawork ulw 移山 yishan persist 愚公 yugong 愚公移山模式
架构 设计 策略 architecture design strategy 诸葛 zhuge consult 规划 planning 诸葛顾问提示
fix bug fix error debug 调试 报错 异常 exception 扁鹊 bianque 诊断 diagnose 扁鹊诊断提示
安全 漏洞 注入 security vulnerability injection 墨子 mozi audit 审计 墨子安全提示
性能 优化 performance optimize slow 孙子 sunzi perf 瓶颈 bottleneck 孙子性能提示
文档 注释 记录 document comment readme changelog 司马迁 simaqian 史记 司马迁文档提示
API 接口 集成 对接 integrate webhook sdk 郑和 zhenghe 郑和 API 提示
监控 日志 告警 追踪 monitor logging alert 张衡 zhangheng 张衡监控提示
DevOps CI/CD 部署 运维 docker kubernetes 李冰 libing 李冰 DevOps 提示
简洁 简化 重构 KISS YAGNI DRY clean code 老子 laozi 至简 老子简洁提示
测试 单元测试 test TDD jest pytest coverage 包拯 baozheng 包拯测试提示
审查 code review review CR PR 魏征 weizheng 魏征审查提示
数据库 database SQL 表设计 索引 migration 仓颉 cangjie 仓颉数据库提示
超级 chaoji ultrapilot 并行 parallel up 超级模式 (并行加速)
节俭 jiejian ecomode eco 省钱 节约 节俭模式 (智能路由)
蜂群 fengqun swarm 协作 批量 蜂群模式 (多 Agent)

🔧 配置

自定义 Agent

~/.claude/agents/ 创建自定义 Agent:

---
name: custom-agent
description: 我的自定义 Agent
allowed-tools:
  - Read
  - Write
  - Edit
model: sonnet
---

# 自定义 Agent

你的自定义指令...

配置管理系统

oh-my-claude 提供了强大的分层配置系统,支持多种配置方式和运行时热重载。

配置层级(优先级从高到低)

  1. 环境变量 - 最高优先级,用于 CI/CD 和容器化部署
  2. 项目配置 - ./.oh-my-claude.json./oh-my-claude.config.json
  3. 用户配置 - ~/.oh-my-claude/config.json
  4. 全局配置 - ~/.oh-my-claude/config/global.json
  5. 默认配置 - 内置的默认值

配置命令

# 查看当前完整配置
oh-my-claude config show

# 获取特定配置值
oh-my-claude config get debug
oh-my-claude config get agents.defaultTimeout
oh-my-claude config get ui.theme

# 设置配置值
oh-my-claude config set debug true
oh-my-claude config set agents.defaultTimeout 60000
oh-my-claude config set ui.theme dark

# 保存当前配置到文件
oh-my-claude config save
oh-my-claude config save ~/.oh-my-claude/my-config.json

# 重置为默认配置
oh-my-claude config reset

环境变量覆盖

支持以下环境变量进行配置覆盖:

# 基础配置
export OH_MY_CLAUDE_DEBUG=true
export OH_MY_CLAUDE_LOG_LEVEL=debug

# Agent 配置
export OH_MY_CLAUDE_AGENT_TIMEOUT=60000
export OH_MY_CLAUDE_MAX_CONCURRENT=5

# UI 配置
export OH_MY_CLAUDE_THEME=dark
export OH_MY_CLAUDE_LANGUAGE=en-US

# 网络配置
export OH_MY_CLAUDE_TIMEOUT=30000
export OH_MY_CLAUDE_PROXY=http://proxy.company.com:8080

示例配置

项目提供了多种环境的配置示例:

# 查看配置示例
ls examples/configs/

# 使用开发环境配置
cp examples/configs/development.json ~/.oh-my-claude/config.json

# 使用生产环境配置
cp examples/configs/production.json ~/.oh-my-claude/config.json

# 使用最小化配置(适合新用户)
cp examples/configs/minimal.json ~/.oh-my-claude/config.json

开发环境配置特点:

  • 启用调试和详细日志
  • 更长的超时时间
  • 禁用缓存确保最新代码
  • 启用第三方插件支持

生产环境配置特点:

  • 禁用调试,只显示重要日志
  • 优化性能和资源使用
  • 严格的安全策略
  • 自动更新

热重载

启用追踪功能后,配置文件修改会自动重新加载:

oh-my-claude config set advanced.enableTracing true
oh-my-claude config save

现在修改 ~/.oh-my-claude/config.json 文件后会自动生效,无需重启。

自定义 Agent

~/.claude/agents/ 创建自定义 Agent:

---
name: custom-agent
description: 我的自定义 Agent
allowed-tools:
  - Read
  - Write
  - Edit
model: sonnet
---

# 自定义 Agent

你的自定义指令...

禁用 Hook

编辑 hooks/hooks.json 移除不需要的 Hook。

修改关键词

编辑 hooks/keyword-detector.sh 自定义触发关键词。

📱 Telegram 远程控制集成

oh-my-claude 支持通过 Telegram Bot 进行远程控制,让你可以随时随地调度 Agent、执行任务和接收通知。

✨ 核心功能

  • 🤖 远程执行命令 - 通过 Telegram 发送消息触发任何 oh-my-claude 命令
  • 📊 实时状态更新 - 自动推送任务进度、错误信息和完成通知
  • 🎯 Agent 调度 - 远程启动愚公、诸葛、鲁班等任何 Agent
  • 📁 文件传输 - 接收日志文件、代码片段和执行结果
  • 🔐 安全认证 - 基于用户 ID 白名单的访问控制

🚀 快速开始

1. 创建 Telegram Bot

  1. 在 Telegram 中搜索 @BotFather
  2. 发送 /newbot 命令创建新 Bot
  3. 按提示设置 Bot 名称和用户名
  4. 保存 BotFather 返回的 Bot Token(格式:1234567890:ABCdefGHIjklMNOpqrsTUVwxyz

2. 获取你的 Telegram User ID

  1. 在 Telegram 中搜索 @userinfobot
  2. 向它发送任意消息
  3. 记录返回的 User ID(纯数字,如:123456789

3. 配置 oh-my-claude

创建或编辑配置文件 ~/.oh-my-claude/config.json

{
  "telegram": {
    "enabled": true,
    "botToken": "你的Bot Token",
    "allowedUsers": [123456789],
    "notifications": {
      "taskStart": true,
      "taskComplete": true,
      "taskError": true,
      "progress": true
    },
    "maxMessageLength": 4096,
    "timeout": 300000
  }
}

或使用命令行配置:

# 启用 Telegram 集成
oh-my-claude config set telegram.enabled true

# 设置 Bot Token
oh-my-claude config set telegram.botToken "你的Bot Token"

# 添加允许的用户 ID(支持多个用户)
oh-my-claude config set telegram.allowedUsers '[123456789, 987654321]'

# 保存配置
oh-my-claude config save

4. 启动 Telegram Bot

# 启动 Bot 服务
oh-my-claude telegram start

# 或作为守护进程运行
oh-my-claude telegram start --daemon

# 查看 Bot 状态
oh-my-claude telegram status

# 停止 Bot
oh-my-claude telegram stop

📖 使用指南

基本命令

在 Telegram 中向你的 Bot 发送以下命令:

# 查看帮助
/help

# 查看状态
/status

# 执行 oh-my-claude 命令(自动添加前缀 /)
yugong 重构用户模块
wukong 查找登录相关的代码
bianque 诊断这个错误:Cannot read property 'id' of undefined

# 查看正在运行的任务
/tasks

# 取消任务
/cancel <task_id>

# 查看 Agent 列表
/agents

# 查看项目信息
/project

远程执行示例

启动愚公移山模式:

/yishan 实现用户认证功能,包括登录、注册和找回密码

Bot 会实时推送:

  • ✅ 任务已接收
  • 📋 任务分解结果
  • 🔄 每个子任务的进度
  • ✅ 完成通知和结果摘要

快速代码查找:

/wukong 找出所有数据库查询相关的文件

Bug 诊断:

/bianque 用户登录后页面空白,控制台报错 TypeError

文件传输

Bot 支持发送执行结果文件:

# 请求日志文件
/logs

# 请求特定文件内容
/file src/utils/auth.ts

# 获取执行结果
/result <task_id>

⚙️ 高级配置

通知设置

精细控制通知类型:

{
  "telegram": {
    "notifications": {
      "taskStart": true,        // 任务开始通知
      "taskComplete": true,     // 任务完成通知
      "taskError": true,        // 错误通知(推荐开启)
      "progress": true,         // 进度更新(可能较频繁)
      "agentSwitch": false,     // Agent 切换通知
      "fileOperation": false    // 文件操作通知
    },
    "quietHours": {
      "enabled": true,
      "start": "22:00",         // 安静时段开始
      "end": "08:00",           // 安静时段结束
      "timezone": "Asia/Shanghai"
    }
  }
}

安全设置

{
  "telegram": {
    "security": {
      "allowedUsers": [123456789],       // 白名单用户
      "requireConfirmation": true,       // 危险操作需确认
      "dangerousCommands": [             // 需要确认的命令
        "/yishan",
        "/chaoji", 
        "git push",
        "rm -rf"
      ],
      "rateLimiting": {
        "enabled": true,
        "maxRequestsPerMinute": 10       // 每分钟最多请求数
      },
      "logAllCommands": true              // 记录所有命令(审计)
    }
  }
}

代理设置

如果你的服务器需要代理访问 Telegram API:

# 设置 HTTP 代理
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080

# 或在配置文件中设置
oh-my-claude config set telegram.proxy "http://proxy.example.com:8080"

🔐 安全最佳实践

  1. 保护 Bot Token

    • 永远不要公开或提交到 Git
    • 使用环境变量:export OH_MY_CLAUDE_TELEGRAM_TOKEN="your_token"
    • 定期轮换 Token(在 @BotFather 中重新生成)
  2. 限制访问权限

    • 仅添加信任的用户 ID 到白名单
    • 启用 requireConfirmation 防止误操作
    • 定期审查 ~/.oh-my-claude/logs/telegram.log
  3. 网络安全

    • 在生产环境使用 HTTPS 代理
    • 考虑使用 Telegram Webhook 而非轮询模式
    • 启用速率限制防止滥用
  4. 文件访问控制

    {
      "telegram": {
        "fileAccess": {
          "allowRead": true,
          "allowWrite": false,        // 禁止远程写入
          "restrictedPaths": [        // 禁止访问的路径
            "/etc",
            "~/.ssh",
            "~/.aws"
          ],
          "maxFileSize": 10485760     // 最大文件大小 10MB
        }
      }
    }
    

🐛 故障排查

Bot 无响应

# 检查 Bot 状态
oh-my-claude telegram status

# 查看日志
tail -f ~/.oh-my-claude/logs/telegram.log

# 测试 Token 是否有效
curl https://api.telegram.org/bot<YOUR_TOKEN>/getMe

# 重启 Bot
oh-my-claude telegram restart

无法接收消息

  1. 确认你的 User ID 在白名单中
  2. 检查 Bot 是否被阻止(在 Telegram 中点击 Bot 头像查看)
  3. 确认 Bot Token 正确且未过期

命令执行失败

  1. 检查 oh-my-claude 主进程是否运行
  2. 查看详细错误日志:oh-my-claude logs --level debug
  3. 确认有足够的系统资源和权限

🎯 使用场景

场景 1:通勤路上处理紧急 Bug

你:@YourBot /bianque 生产环境用户登录失败,日志显示 JWT token 验证错误

Bot:🩺 扁鹊开始诊断...
     📊 分析了 12 个相关文件
     🔍 发现问题:token 过期时间配置错误
     💊 建议修复:更新 config/jwt.ts 中的 expiresIn 配置
     ✅ 已生成修复 PR #123

场景 2:会议中快速查找信息

你:@YourBot /wukong 支付模块的退款逻辑在哪里

Bot:🔍 悟空侦察完成
     📁 找到 3 个关键文件:
        - src/services/payment/refund.service.ts
        - src/controllers/refund.controller.ts  
        - src/models/refund.model.ts
     📤 [发送文件内容]

场景 3:深夜自动化任务

你:@YourBot /yishan 生成本周的代码统计报告并发送给团队

Bot:🏔️ 愚公开始工作...
     ✅ 任务1: 收集 Git 提交数据
     ✅ 任务2: 分析代码变更统计
     ✅ 任务3: 生成可视化图表
     ✅ 任务4: 编写报告文档
     ✅ 任务5: 发送邮件通知
     🎉 全部完成![查看报告]

🌟 提示与技巧

  • 💡 使用 /agents 命令快速查看所有可用 Agent 及其专长
  • 💡 为常用命令创建 Telegram 快捷回复
  • 💡 在 Bot 描述中添加常用命令列表(通过 @BotFather 的 /setcommands
  • 💡 启用安静时段避免深夜被打扰
  • 💡 配合 Telegram 群组使用,实现团队协作通知

📖 文化背景

愚公 (YuGong)

《列子·汤问》中的老者,年近九十仍坚持移山。最终感动天帝,派夸娥氏二子背走大山。象征坚持不懈的精神。

诸葛 (ZhuGe)

三国时期蜀汉丞相诸葛亮,字孔明。"未出茅庐,已知三分天下",是中国历史上最著名的战略家。

鲁班 (LuBan)

春秋战国时期工匠,发明了锯子、墨斗、刨子等工具。被尊为中国工匠的始祖,"百工圣祖"。

悟空 (WuKong)

《西游记》中的孙悟空,拥有火眼金睛和七十二变。能识破一切伪装,行动迅速敏捷。

扁鹊 (BianQue)

战国时期神医,创立望闻问切四诊法。医术高超,能起死回生。

墨子 (MoZi)

墨家学派创始人,主张"兼爱非攻"。精通防御工事和守城策略,以防御智慧著称。

孙子 (SunZi)

《孙子兵法》作者,"知己知彼,百战不殆"。世界公认的军事战略经典,强调分析和策略。

司马迁 (SimaQian)

西汉史学家,被誉为"史圣"。著有《史记》,开创纪传体通史先河,"究天人之际,通古今之变,成一家之言"。

郑和 (ZhengHe)

明代伟大航海家,七下西洋,远航至东南亚、印度洋、波斯湾和非洲东海岸。他的船队促进了中外文化交流和贸易往来,体现了"开放、探索、连接"的精神。

张衡 (ZhangHeng)

东汉杰出科学家、天文学家。发明了世界上第一台地震仪——候风地动仪,能够感知远方地震并指示方向。还改进了浑天仪,精确测量天体运行,体现了"观测、感知、预警"的智慧。

李冰 (LiBing)

战国时期蜀郡太守,主持修建都江堰水利工程。都江堰历经两千多年仍在发挥作用,体现了"顺势而为、分而治之"的工程智慧,被誉为世界水利史上的奇迹。

老子 (LaoZi)

道家学派创始人,著有《道德经》。他提出"道法自然"、"无为而治"的哲学思想,强调"大道至简"——最高深的道理往往是最简单的。老子的智慧在于:去除繁杂,回归本质。

包拯 (BaoZheng)

北宋名臣,人称"包青天"、"包公"。以铁面无私、明察秋毫著称,任开封府尹时公正严明,不畏权贵。龙头铡、虎头铡、狗头铡象征对各阶层的公正执法,体现"公正无私、明察秋毫"的精神。

魏征 (WeiZheng)

唐代著名谏臣,辅佐唐太宗开创贞观之治。以直言敢谏著称,唐太宗称其为"镜子"。"以铜为镜,可以正衣冠;以人为镜,可以明得失",体现"直言不讳、明辨是非"的精神。

仓颉 (CangJie)

传说中的造字始祖,黄帝时期史官。相传他有四只眼睛,仰观天象、俯察鸟兽之迹,创造了汉字。体现"观察规律、创造结构"的智慧。

🗺️ 路线图

  • v0.1.0 - 基础 Agent 体系(5 个 Agent)
  • v0.2.0 - Agent 协作增强(@agent 调用语法、/team 命令)
  • v0.3.0 - 更多 Agent(墨子、孙子)
  • v0.4.0 - 可视化进度面板(/progress 命令)
  • v0.5.0 - 更多 Agent(司马迁)
  • v0.6.0 - 更多 Agent(郑和、张衡、李冰)
  • v0.7.0 - 更多 Agent(老子)
  • v0.8.0 - 更多 Agent(包拯、魏征、仓颉)
  • v0.9.0 - 更多 Agent(李白、顾恺之、嫦娥)
  • v1.0.0 - 首个正式版发布 🎉
  • v1.1.0 - 愚公移山循环 v2.0 重设计
  • v1.2.0 - CLI 模块化重构、测试覆盖率优化
  • v1.3.0 - P0 功能对齐(愚公增强、Git Master、Ralph Loop)
  • v1.4.0 - P1 功能对齐(重试 Hooks、会话恢复、Metis/Prometheus)
  • v1.5.0 - P2 增强功能(JSONC 配置、监控 Hooks)
  • v1.6.0 - 功能对齐完成 🎯(与 oh-my-opencode 95% 对齐)
  • v1.7.0 - 100% 功能对齐 🚀(MCP 自动安装、Session 工具、新 Agent)
  • v2.0.0 - 重大更新 ✨(npm 包名变更为 claude-pangu、CLI 安装简化)
  • v2.0.1 - Agent 就绪通知(OS 级桌面通知)
  • v2.0.2 - Agent 分派优化(关键词检测精准化)
  • v2.0.3 - 愚公移山 v2.1 🏔️(智能动态工作流、测试-修复循环、强制代码清理)
  • v2.0.4 - 版本同步修复
  • v2.0.5 - 卸载完整清理 🧹(清理 commands、skills、旧版 zcf 目录)
  • v2.0.6 - 项目本地 zcf 清理 🧹(安装/卸载时清理项目目录的旧版命令)
  • v2.0.7 - 全局 zcf 扫描清理 🔍(卸载时自动扫描并清理所有项目的旧版目录)
  • v2.0.8 - 历史版本命令清理 🧹(清理 huitu.md、xuanwu.md 等已重命名的旧命令)
  • v2.0.9 - 卸载残留检测修复 🐛(插件目录不存在时仍清理 commands/skills 残留)
  • v2.0.10 - 备用清理列表生效 🐛(修复动态扫描返回空时未使用备用列表)
  • v2.0.11 - 始终完整清理 🐛(避免 npx 旧版缓存导致清理不完整)
  • v2.0.12 - CI 构建修复 🐛(移除未使用变量和函数)
  • v2.0.13 - 历史版本检测增强 🔍(支持仅有 zcf 目录的旧版本检测)
  • v2.0.14 - 易用性增强 ✨(新增 /do 极简入口、/suggest 智能推荐、/cheatsheet 速查表)
  • v2.0.15 - 用户体验深度优化 🎯(新增 /what 意图识别、/quickfix 快速修复、/recipes 场景指南)
  • v2.0.16 - 活跃会话命令文档 📖(斜杠命令限制说明、自然语言替代方案、Linux 兼容性修复)
  • v2.1.0 - 重大功能升级 🚀(13 个新命令、14 个技能模块、105 个测试用例)
  • v2.1.1 - 别名冲突修复 🔧(移除与其他工具冲突的通用英文别名)
  • v2.1.2 - 用户体验简化 🎯(/do 作为唯一入口、精简帮助输出)
  • v2.1.3 - 版本检测修复 🐛(plugin.json 版本同步)
  • v2.1.4 - 用户体验第三轮 ✨(工作流模板、偏好设置、友好错误、自诊断)
  • v2.1.5 - macOS 兼容性修复 🍎(Shell 脚本跨平台兼容、grep 语法修复)
  • v2.1.6 - 稳定性与精准度优化 🎯(关键词误判修复、愚公循环增强、Hook 去重)
  • v2.1.7 - 自然语言交互增强 💬(停止/进度查询支持、PR 误匹配修复)
  • v2.1.8 - 项目本地残留清理 🧹(安装时自动清理 zcf 目录残留)
  • v2.1.9 - npx 安装修复 🐛(isMainModule 检测增强)
  • v2.1.10 - ESM 路径解析修复 🐛(import.meta.url + realpathSync 完整修复 npx 安装)
  • v2.1.12 - 用户体验优化第四轮 ✨(场景化快速开始 /quickstart、常用命令英文别名)
  • v2.1.13 - 增强错误恢复引导 🔧(更友好的错误提示和恢复建议)
  • v2.1.14 - 自然语言自动激活 💬(16 个 Agent 支持自然语言直接激活)
  • v2.1.15 - 启动时自动更新 🔄(后台静默检查和更新)
  • v2.1.16 - 关键词精准度优化 🎯(减少误触发,提升识别准确率)
  • v2.1.17 - 功能对齐增强 🚀(Metis/Oracle/Librarian Agent, Tmux 可视化, Frontend UI/UX)
  • v2.2.0 - oh-my-claudecode 功能集成 ⚡(三大核心功能:超级模式/节俭模式/蜂群模式,Agent 分层体系)
  • v2.2.1 - 第二阶段功能集成 📦(5 个新技能 + 3 个新 Agent + 新命令)
  • v2.2.2 - 第三阶段功能集成 🔬(3 个新技能 + 5 个 Agent 变体)
  • v2.2.17 - Hooks 验证增强 ✅(安装验证显示 hooks 状态)
  • v2.2.18 - 代码清理 🧹(删除废弃 JS 文件,更新开发文档)
  • v2.2.22 - Hook 系统根本性修复 🔧(stdin JSON 读取、PostToolUse 崩溃修复、WSL 符号链接保护)
  • v2.3.0 - oh-my-opencode v3.8.4 全面移植 🚀(9 Agent 重写 + 6 新 Hook + 5 命令更新 + 4 技能升级)
  • v2.3.1 - Hook 注册修复 🐛(syncHooksToSettings 完善 Wave 2 Hook 注册,新增 4 测试用例)
  • v2.3.2 - Hook 无 jq 回退修复 🐛(4 个 Hook 的 Windows/无 jq 环境兼容性修复)
  • v2.3.3 - Hook 逻辑修复 🐛(json-error-recovery 模式排序 + write-existing-file-guard 路径排除修复)
  • v2.3.4 - JSON 错误检测增强 \uD83D\uDC1B(json-error-recovery 增加 "unclosed string" 模式匹配)

v2.2.2 核心更新

🆕 新增技能(灵感来源:oh-my-claudecode

技能 命令 说明
🔬 Research (研究编排) /yanjiu /research /rs 多科学家并行研究,交叉验证
🧪 TDD (测试驱动开发) /honglv /tdd /test-first Red→Green→Refactor 循环
📦 Release (自动化发布) /fabu /release /rel 标准化版本发布流程

🆕 Agent 变体扩展

Agent 版本 模型 专长
悟空 wukong-medium Sonnet 深度代码分析
悟空 wukong-high Opus 架构级洞察
鲁班 luban-high Opus 复杂重构
祖冲之 scientist-high Opus 因果推断/ML
狄仁杰 qa-tester-high Opus 测试架构设计

v2.2.1 核心更新

🆕 新增技能(灵感来源:oh-my-claudecode

技能 命令 说明
🔍 DeepSearch (深度搜索) /shensou /deepsearch /ds 多策略并行搜索,彻底查找
🧪 UltraQA (自主测试) /ceshi /ultraqa /qa 自动测试循环,直到全部通过
🎯 RalPlan (迭代规划) /gongshi /ralplan /plan+ Planner+Architect+Critic 三方共识
📝 Note (笔记本) /biji /note /n 压缩抗性笔记,重要信息不丢失
🏥 Doctor (诊断修复) /doctor /zhenduan /diag 自动诊断并修复安装问题

🆕 新增 Agent

Agent 名称 专长 命令
📊 祖冲之 (ZuChongZhi) 数据分析、统计检验 /scientist /zuchongzhi
🔍 狄仁杰 (DiRenJie) QA 测试、交互式测试 /qa-tester /direnjie
🌊 大禹 (DaYu) 构建修复、CI/CD 故障 /build-fixer /dayu

🆕 Agent 分层体系扩展

新增 LOW 版本 Agent:scientist-low, qa-tester-low, build-fixer-low

v2.2.0 核心更新

🆕 三大执行模式(灵感来源:oh-my-claudecode

功能 命令 说明
⚡ Ultrapilot (超级模式) /chaoji /ultrapilot 并行执行,最多 5 倍加速
💰 Ecomode (节俭模式) /jiejian /ecomode 智能模型路由,节省 30-50% Token
🐝 Swarm (蜂群模式) /fengqun N:agent /swarm N 个同类 Agent 共享任务池协作

🆕 Agent 分层体系

层级 模型 Agent 用途
LOW Haiku zhuge-low, luban-low, baozheng-low 等 简单任务,节省成本
MEDIUM Sonnet 原有 Agent 标准任务
HIGH Opus zhuge (复杂架构) 高难度任务

🤝 贡献

欢迎贡献!请查看 CONTRIBUTING.md 了解如何参与。

你可以:

  1. 🐛 提交 Issue 报告问题或建议
  2. 🔧 Fork 后提交 Pull Request
  3. 🎭 添加新的 Agent 或命令
  4. 📝 改进文档
  5. 🌐 完善国际化支持

📜 许可证

MIT License © 2025 oh-my-claude

🙏 致谢


愚公精神:坚持必将成功 🏔️

报告问题 · 提出建议 · 贡献代码

Reviews (0)

No results found