├── QUICKSTART.md ├── TROUBLESHOOTING.md └── README.md /QUICKSTART.md: -------------------------------------------------------------------------------- 1 | # SuperClaude 快速开始指南 2 | 3 | ## 🚀 一键安装 4 | 5 | ```bash 6 | # 克隆原项目 7 | git clone https://github.com/NomenAK/SuperClaude.git 8 | cd SuperClaude 9 | 10 | # 一键安装 11 | ./install.sh 12 | ``` 13 | 14 | ## ⚡ 立即试用 15 | 16 | 安装完成后，在任何项目中使用 Claude Code： 17 | 18 | ```bash 19 | # 启动 Claude Code 20 | claude 21 | 22 | # 尝试这些命令 23 | /user:analyze --code # 分析代码 24 | /persona:architect # 切换到架构师模式 25 | /user:design --api # 设计API 26 | /user:build --react # 构建React应用 27 | /user:git --checkpoint # 创建检查点 28 | ``` 29 | 30 | ## 🎭 常用人格模式 31 | 32 | | 命令 | 用途 | 33 | |------|------| 34 | | `/persona:architect` | 系统架构设计 | 35 | | `/persona:frontend` | 前端界面开发 | 36 | | `/persona:backend` | 后端API开发 | 37 | | `/persona:analyzer` | 问题分析调试 | 38 | | `/persona:security` | 安全审计 | 39 | 40 | ## 🛠️ 核心命令速查 41 | 42 | | 命令 | 功能 | 43 | |------|------| 44 | | `/user:analyze` | 代码分析 | 45 | | `/user:build` | 项目构建 | 46 | | `/user:test` | 测试执行 | 47 | | `/user:improve` | 代码优化 | 48 | | `/user:git` | Git操作 | 49 | 50 | ## 📖 完整文档 51 | 52 | 查看 [README.md](README.md) 获取详细的安装和使用指南。 53 | 54 | ## 🔗 原项目 55 | 56 | [SuperClaude 原始仓库](https://github.com/NomenAK/SuperClaude) -------------------------------------------------------------------------------- /TROUBLESHOOTING.md: -------------------------------------------------------------------------------- 1 | # 故障排除指南 2 | 3 | ## 🔧 常见安装问题 4 | 5 | ### 问题1: 权限错误 6 | ```bash 7 | Error: No write permission for ~/.claude/ 8 | ``` 9 | 10 | **解决方案：** 11 | ```bash 12 | # 检查目录权限 13 | ls -la ~/.claude/ 14 | 15 | # 修复权限 16 | sudo chown -R $USER:$USER ~/.claude/ 17 | chmod -R 755 ~/.claude/ 18 | ``` 19 | 20 | ### 问题2: 找不到 Claude Code 21 | ```bash 22 | claude: command not found 23 | ``` 24 | 25 | **解决方案：** 26 | 1. 确保已安装 Claude Code： 27 | ```bash 28 | # 检查 Claude Code 是否已安装 29 | which claude 30 | ``` 31 | 32 | 2. 如果未安装，请访问 [Anthropic 官方文档](https://docs.anthropic.com) 获取安装指南 33 | 34 | ### 问题3: Git 未安装 35 | ```bash 36 | git: command not found 37 | ``` 38 | 39 | **解决方案：** 40 | ```bash 41 | # Ubuntu/Debian 42 | sudo apt update && sudo apt install git 43 | 44 | # macOS 45 | brew install git 46 | 47 | # 或使用 Xcode Command Line Tools 48 | xcode-select --install 49 | ``` 50 | 51 | ### 问题4: 安装脚本失败 52 | ```bash 53 | Error: This script must be run from the SuperClaude directory 54 | ``` 55 | 56 | **解决方案：** 57 | ```bash 58 | # 确保在正确的目录中 59 | pwd 60 | ls -la 61 | 62 | # 应该能看到 CLAUDE.md 和 install.sh 文件 63 | # 如果没有，重新克隆仓库 64 | git clone https://github.com/NomenAK/SuperClaude.git 65 | cd SuperClaude 66 | ./install.sh 67 | ``` 68 | 69 | ## 🐛 使用问题 70 | 71 | ### 问题1: 命令不识别 72 | ```bash 73 | /user:analyze --code 74 | # 没有反应或提示错误 75 | ``` 76 | 77 | **解决方案：** 78 | ```bash 79 | # 检查配置文件是否存在 80 | ls ~/.claude/ 81 | ls ~/.claude/commands/ 82 | 83 | # 重新加载配置 84 | /user:load 85 | 86 | # 或重新安装 87 | cd SuperClaude 88 | ./install.sh --force 89 | ``` 90 | 91 | ### 问题2: 人格模式无效 92 | ```bash 93 | /persona:architect 94 | # 没有切换效果 95 | ``` 96 | 97 | **解决方案：** 98 | ```bash 99 | # 检查 PERSONAS.md 文件 100 | cat ~/.claude/PERSONAS.md 101 | 102 | # 重新安装如果文件缺失 103 | ./install.sh --update 104 | ``` 105 | 106 | ### 问题3: 检查点功能不工作 107 | ```bash 108 | /user:git --checkpoint 109 | # 提示 Git 错误 110 | ``` 111 | 112 | **解决方案：** 113 | ```bash 114 | # 初始化 Git 仓库（如果项目未使用 Git） 115 | git init 116 | git config user.name "Your Name" 117 | git config user.email "your.email@example.com" 118 | 119 | # 或在现有 Git 项目中使用 120 | cd your-git-project 121 | claude 122 | ``` 123 | 124 | ## 🔄 重新安装 125 | 126 | 如果遇到无法解决的问题，可以完全重新安装： 127 | 128 | ```bash 129 | # 1. 卸载现有安装 130 | cd SuperClaude 131 | ./install.sh --uninstall 132 | 133 | # 2. 清理残留文件（可选） 134 | rm -rf ~/.claude/ 135 | 136 | # 3. 重新安装 137 | ./install.sh 138 | 139 | # 4. 验证安装 140 | claude 141 | /user:load 142 | ``` 143 | 144 | ## 🆘 获取帮助 145 | 146 | 如果以上解决方案都无效： 147 | 148 | 1. **检查原项目 Issues**：[SuperClaude Issues](https://github.com/NomenAK/SuperClaude/issues) 149 | 150 | 2. **查看安装日志**： 151 | ```bash 152 | ./install.sh 2>&1 | tee install.log 153 | ``` 154 | 155 | 3. **提供系统信息**： 156 | ```bash 157 | # 操作系统信息 158 | uname -a 159 | 160 | # Bash 版本 161 | bash --version 162 | 163 | # Git 版本 164 | git --version 165 | 166 | # Claude Code 版本（如果可用） 167 | claude --version 168 | ``` 169 | 170 | 4. **加入社区讨论**：[SuperClaude Discussions](https://github.com/NomenAK/SuperClaude/discussions) 171 | 172 | ## 📋 快速诊断检查清单 173 | 174 | - [ ] 已安装 Claude Code 175 | - [ ] 已安装 Git 176 | - [ ] 在 SuperClaude 目录中运行安装脚本 177 | - [ ] 有 ~/.claude/ 目录的写权限 178 | - [ ] ~/.claude/ 目录包含所需文件： 179 | - [ ] CLAUDE.md 180 | - [ ] RULES.md 181 | - [ ] PERSONAS.md 182 | - [ ] MCP.md 183 | - [ ] commands/ 目录 184 | - [ ] commands/shared/ 目录 185 | - [ ] 在 Git 仓库中使用 Claude Code（检查点功能需要） 186 | 187 | 完成所有检查后，SuperClaude 应该能正常工作。 -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SuperClaude 中文操作指南 2 | 3 | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) 4 | [![Version](https://img.shields.io/badge/version-4.0.0-blue.svg)](https://github.com/NomenAK/SuperClaude) 5 | 6 | **一个轻量级框架，将通用的 Claude Code 转换为您的专业开发合作伙伴 - 无需外部工具，无需复杂设置，仅需纯配置魔法。** 7 | 8 | ## 📖 项目介绍 9 | 10 | SuperClaude 是一个增强 Claude Code 功能的配置框架。它解决了以下问题： 11 | - Claude Code 过于通用，缺乏专业性 12 | - 在调试过程中经常丢失上下文 13 | - 每个项目都需要重复相同的指令 14 | - 希望 AI 能理解您的编码风格 15 | - 冗长的回复消耗了大量 token 16 | 17 | ## ✨ 主要特性 18 | 19 | ### 🔄 **永不丢失上下文** 20 | 基于 Git 的检查点系统，让您可以回到对话中的任何时点。 21 | 22 | ### 📚 **智能文档系统** 23 | 使用 token 优化模板自动生成文档。项目文档保存在 `/docs` 目录，而 Claude 的工作笔记保存在 `/.claudedocs` 目录。 24 | 25 | ### 🎭 **9 种即时人格模式** 26 | 一个命令即可切换 Claude 的整个思维模式： 27 | - `architect` - 大局观系统设计模式 28 | - `frontend` - 像素级完美 UI 强迫症模式 29 | - `security` - 偏执威胁建模模式 30 | - `analyzer` - 福尔摩斯调试模式 31 | - `qa` - 极致bug猎手模式 32 | - `performance` - 性能恶魔模式 33 | - `refactorer` - 代码美化师模式 34 | - `backend` - 性能强迫症模式 35 | - `mentor` - 耐心导师模式 36 | 37 | ### ⚡ **18 个强力命令** 38 | 为实际工作提供真正的快捷方式 39 | 40 | ### 🧠 **智能集成** 41 | - **Context7** 即时查找库文档 42 | - **Sequential** 复杂问题的逐步思考 43 | - **Magic** 生成真正符合您风格的 UI 组件 44 | - **Puppeteer** 在真实浏览器中测试一切 45 | 46 | ## 🚀 零摩擦安装 47 | 48 | ### 前置要求 49 | 50 | 1. **Claude Code** - 您需要先安装 Anthropic 的 Claude Code 工具 51 | 2. **Git** - 用于版本控制和检查点功能 52 | 3. **Bash** - 运行安装脚本 53 | 54 | ### 安装步骤 55 | 56 | #### 步骤 1: 克隆仓库 57 | ```bash 58 | git clone https://github.com/NomenAK/SuperClaude.git 59 | cd SuperClaude 60 | ``` 61 | 62 | #### 步骤 2: 运行安装脚本 63 | ```bash 64 | # 默认安装到 ~/.claude/ 65 | ./install.sh 66 | 67 | # 或者安装到自定义位置 68 | ./install.sh --dir /opt/claude # 系统级安装 69 | ./install.sh --dir ./project-claude # 项目级安装 70 | ``` 71 | 72 | #### 步骤 3: 验证安装 73 | 安装完成后，您会看到类似以下的输出： 74 | ``` 75 | ✓ SuperClaude installed successfully! 76 | 77 | Next steps: 78 | 1. Open any project with Claude Code 79 | 2. Try a command: /user:analyze --code 80 | 3. Activate a persona: /persona:architect 81 | ``` 82 | 83 | ### 安装选项说明 84 | 85 | | 选项 | 说明 | 86 | |------|------| 87 | | `--dir <目录>` | 安装到自定义目录（默认：~/.claude/） | 88 | | `--force` | 跳过确认提示（用于自动化） | 89 | | `--update` | 更新现有安装（保留自定义配置） | 90 | | `--uninstall` | 从指定目录移除 SuperClaude | 91 | | `-h, --help` | 显示帮助信息 | 92 | 93 | ## 💡 快速入门 94 | 95 | ### 第一次使用 96 | 97 | 1. **打开任何项目** 98 | ```bash 99 | cd your-project 100 | claude 101 | ``` 102 | 103 | 2. **尝试第一个命令** 104 | ```bash 105 | /user:analyze --code 106 | ``` 107 | 108 | 3. **激活一个人格模式** 109 | ```bash 110 | /persona:architect 111 | ``` 112 | 113 | ### 常用工作流程示例 114 | 115 | #### 新项目流程 116 | ```bash 117 | /persona:architect 118 | /user:design --api --ddd # 从领域驱动设计开始 119 | /user:estimate --detailed # 了解您要构建的内容 120 | /persona:backend 121 | /user:build --api --tdd # 第一次就正确构建 122 | ``` 123 | 124 | #### 故障排除流程 125 | ```bash 126 | /persona:analyzer 127 | /user:troubleshoot --investigate --prod 128 | /user:analyze --profile # 找到真正的瓶颈 129 | /persona:performance 130 | /user:improve --performance --threshold 90% 131 | ``` 132 | 133 | #### 美化界面流程 134 | ```bash 135 | /persona:frontend 136 | /user:build --react --magic # AI 生成的组件 137 | /user:test --e2e --pup # 在真实浏览器中查看效果 138 | /user:improve --quality # 抛光直到闪亮 139 | ``` 140 | 141 | ## 🎭 人格模式详解 142 | 143 | | 人格 | 超能力 | 何时激活 | 144 | |------|--------|----------| 145 | | **architect** | 看到大局 | 需要可扩展的系统设计时 | 146 | | **frontend** | UX 完美主义者 | 需要用户喜爱的界面时 | 147 | | **backend** | 性能强迫症 | 需要永不失败的 API 时 | 148 | | **security** | 专业偏执狂 | 需要防弹代码时 | 149 | | **analyzer** | 根因探测器 | 需要解决无法解决的问题时 | 150 | | **qa** | 极致 bug 猎手 | 需要捕获一切的测试时 | 151 | | **performance** | 速度恶魔 | 每毫秒都很重要时 | 152 | | **refactorer** | 代码美化师 | 需要简化复杂代码时 | 153 | | **mentor** | 耐心老师 | 需要理解而不只是复制时 | 154 | 155 | ## 🛠️ 核心命令详解 156 | 157 | ### 分析命令 (`/user:analyze`) 158 | ```bash 159 | /user:analyze --code # 代码质量分析 160 | /user:analyze --security # 安全审计 161 | /user:analyze --performance # 性能分析 162 | /user:analyze --structure # 架构分析 163 | ``` 164 | 165 | ### 构建命令 (`/user:build`) 166 | ```bash 167 | /user:build --react # React 应用 168 | /user:build --api # API 服务 169 | /user:build --component # 组件库 170 | /user:build --fullstack # 全栈应用 171 | ``` 172 | 173 | ### 测试命令 (`/user:test`) 174 | ```bash 175 | /user:test --unit # 单元测试 176 | /user:test --e2e # 端到端测试 177 | /user:test --integration # 集成测试 178 | /user:test --performance # 性能测试 179 | ``` 180 | 181 | ### 改进命令 (`/user:improve`) 182 | ```bash 183 | /user:improve --performance # 性能优化 184 | /user:improve --security # 安全加固 185 | /user:improve --quality # 代码质量 186 | /user:improve --accessibility # 可访问性 187 | ``` 188 | 189 | ### Git 命令 (`/user:git`) 190 | ```bash 191 | /user:git --checkpoint # 创建检查点 192 | /user:git --rollback # 回滚到检查点 193 | /user:git --branch # 创建新分支 194 | /user:git --merge # 合并分支 195 | ``` 196 | 197 | ## 🔧 高级功能 198 | 199 | ### 思考模式控制 200 | ```bash 201 | "think about X" # 标准分析 202 | "think hard about Y" # 架构级深度 203 | "ultrathink Z" # 考虑一切的时候 204 | ``` 205 | 206 | ### 智能工具控制 207 | ```bash 208 | --c7 # 强制文档查找 209 | --seq # 强制逐步推理 210 | --magic # 强制 UI 组件生成 211 | --no-mcp # 仅使用原生工具 212 | --all-mcp # 厨房水槽模式 213 | ``` 214 | 215 | ### 检查点系统 216 | SuperClaude 的 Git 集成检查点系统让您永远不会丢失工作进度： 217 | 218 | 1. **创建检查点** 219 | ```bash 220 | /user:git --checkpoint "开始重构前的安全点" 221 | ``` 222 | 223 | 2. **查看检查点** 224 | ```bash 225 | /user:git --list 226 | ``` 227 | 228 | 3. **回滚到检查点** 229 | ```bash 230 | /user:git --rollback checkpoint-name 231 | ``` 232 | 233 | ## 📁 文件结构 234 | 235 | 安装后，SuperClaude 会在指定目录创建以下结构： 236 | 237 | ``` 238 | ~/.claude/ 239 | ├── CLAUDE.md # 核心配置和行为 240 | ├── RULES.md # 工程标准和实践 241 | ├── PERSONAS.md # 9 种专业思维模式 242 | ├── MCP.md # 智能工具编排 243 | ├── commands/ # 18 个命令 244 | │ ├── analyze.md 245 | │ ├── build.md 246 | │ ├── improve.md 247 | │ ├── test.md 248 | │ └── ... 249 | └── commands/shared/ # 26 个共享资源 250 | ├── patterns.yml 251 | ├── templates.yml 252 | └── ... 253 | ``` 254 | 255 | ## 🚀 实际使用场景 256 | 257 | ### 场景 1: 调试生产问题 258 | ```bash 259 | # 切换到分析师模式 260 | /persona:analyzer 261 | 262 | # 开始故障排除 263 | /user:troubleshoot --prod --investigate 264 | 265 | # 深度分析 266 | /user:analyze --logs --performance --security 267 | 268 | # 创建解决方案检查点 269 | /user:git --checkpoint "找到解决方案前" 270 | 271 | # 实施修复 272 | /user:improve --performance --hotfix 273 | ``` 274 | 275 | ### 场景 2: 开发新功能 276 | ```bash 277 | # 切换到架构师模式进行设计 278 | /persona:architect 279 | /user:design --feature --scalable 280 | 281 | # 切换到后端开发模式 282 | /persona:backend 283 | /user:build --api --tdd 284 | 285 | # 切换到前端模式创建界面 286 | /persona:frontend 287 | /user:build --component --responsive 288 | 289 | # 综合测试 290 | /persona:qa 291 | /user:test --e2e --complete 292 | ``` 293 | 294 | ### 场景 3: 代码重构 295 | ```bash 296 | # 创建重构前检查点 297 | /user:git --checkpoint "重构前的稳定版本" 298 | 299 | # 切换到重构师模式 300 | /persona:refactorer 301 | 302 | # 分析现有代码 303 | /user:analyze --structure --complexity 304 | 305 | # 执行重构 306 | /user:improve --maintainability --clean 307 | 308 | # 验证重构结果 309 | /user:test --regression --performance 310 | ``` 311 | 312 | ## ⚡ 性能优化 313 | 314 | SuperClaude 提供 70% 的 token 减少，具体通过以下方式实现： 315 | 316 | 1. **UltraCompressed 模式** - 去除不必要的 token 而不失清晰度 317 | 2. **智能上下文管理** - 只保留相关信息 318 | 3. **优化的命令结构** - 减少重复指令 319 | 4. **高效的人格切换** - 快速模式转换 320 | 321 | ## 🛟 故障排除 322 | 323 | ### 安装问题 324 | ```bash 325 | # 重新运行安装（幂等的） 326 | ./install.sh 327 | 328 | # 查看安装选项 329 | ./install.sh --help 330 | 331 | # 强制重新安装 332 | ./install.sh --force 333 | ``` 334 | 335 | ### 命令不工作 336 | ```bash 337 | # 检查安装的命令 338 | ls ~/.claude/commands/ 339 | 340 | # 重新加载配置 341 | /user:load 342 | ``` 343 | 344 | ### 权限问题 345 | ```bash 346 | # 检查目录权限 347 | ls -la ~/.claude/ 348 | 349 | # 修复权限 350 | chmod -R 755 ~/.claude/ 351 | ``` 352 | 353 | ## 🔄 更新和维护 354 | 355 | ### 更新 SuperClaude 356 | ```bash 357 | cd SuperClaude 358 | git pull 359 | ./install.sh --update 360 | ``` 361 | 362 | ### 备份配置 363 | ```bash 364 | # 手动备份 365 | cp -r ~/.claude/ ~/.claude.backup.$(date +%Y%m%d) 366 | 367 | # 安装时自动备份 368 | ./install.sh # 会自动创建备份 369 | ``` 370 | 371 | ### 卸载 372 | ```bash 373 | ./install.sh --uninstall 374 | ``` 375 | 376 | ## 🤝 贡献和社区 377 | 378 | SuperClaude 是 MIT 许可的开源项目，由开发者为开发者构建。我们欢迎： 379 | 380 | - 专门工作流程的新人格模式 381 | - 解决日常痛点的命令 382 | - 使 Claude Code 更智能的模式 383 | - 推动边界的想法 384 | 385 | ## 📊 效果对比 386 | 387 | | 功能 | 没有 SuperClaude | 使用 SuperClaude | 388 | |------|------------------|------------------| 389 | | **上下文** | 错误后丢失 | Git 检查点保留一切 | 390 | | **人格** | 通用回复 | 专业思维模式 | 391 | | **Token** | 冗长输出 | 减少 70%，相同信息 | 392 | | **文档** | "我认为这样工作" | 总是找到官方来源 | 393 | | **工作流** | 重复指令 | 一个命令，完整流程 | 394 | | **质量** | 希望最好的结果 | 基于证据的标准 | 395 | 396 | ## 🎯 适用人群 397 | 398 | **完美适合如果您：** 399 | - ✅ 希望在项目间获得一致的 AI 协助 400 | - ✅ 重视证据胜过意见 401 | - ✅ 需要专业化思维模式 402 | - ✅ 关心 token 效率 403 | - ✅ 喜欢开箱即用的工具 404 | 405 | **跳过如果您：** 406 | - ❌ 偏好完全手动控制 407 | - ❌ 不经常使用 Claude Code 408 | - ❌ 满足于通用 AI 回复 409 | 410 | ## 🚦 2 分钟快速开始 411 | 412 | 1. **安装** 413 | ```bash 414 | git clone https://github.com/NomenAK/SuperClaude.git && cd SuperClaude && ./install.sh 415 | ``` 416 | 417 | 2. **试用** 418 | ```bash 419 | /user:analyze --code # 看看它能找到什么 420 | /persona:architect # 尝试新的思维方式 421 | ``` 422 | 423 | 3. **深入探索** 424 | - 探索命令：`/user:load` 425 | - 阅读指南：`~/.claude/commands/` 426 | - 加入社区：[讨论区](https://github.com/NomenAK/SuperClaude/discussions) 427 | 428 | ## 📞 获得帮助 429 | 430 | - **安装问题？** 再次运行 `./install.sh` - 它是幂等的 431 | - **命令无效？** 检查 `ls ~/.claude/commands/` 432 | - **想要贡献？** 查看原项目的 CONTRIBUTING.md 433 | - **发现 bug？** 在原项目[开启 issue](https://github.com/NomenAK/SuperClaude/issues) 434 | 435 | ## 🔗 相关链接 436 | 437 | - [原项目仓库](https://github.com/NomenAK/SuperClaude) 438 | - [Claude Code 官方文档](https://docs.anthropic.com) 439 | - [项目讨论区](https://github.com/NomenAK/SuperClaude/discussions) 440 | 441 | --- 442 | 443 | **SuperClaude v4.0.0 - 因为通用 AI 助手已经不够好了。** 444 | 445 | *本指南由 Claude 根据原项目文档翻译和整理，如有疑问请参考原英文文档。* --------------------------------------------------------------------------------