SuperClaude Framework 使用指南
SuperClaude Framework 是一个开源配置框架,将 Claude Code 从通用 AI 助手转变为专业的上下文感知开发伙伴。该框架通过模板驱动架构应用软件工程原理,为专业软件开发工作流程提供了强大的增强功能。目前该项目处于 v3.0 版本(2025年7月刚出测试版),拥有活跃的社区支持和持续的开发维护。
主要功能和用途
SuperClaude Framework 的核心目标是通过专业化的命令、认知人格和结构化开发方法论来增强 Claude Code,解决通用 AI 助手在专业软件开发工作流程中的局限性。
16个专业化命令系统
框架提供了完整的开发生命周期支持:
开发类命令 :/sc:implement
(功能实现)、/sc:build
(项目构建)、/sc:design
(系统设计)等,支持完整的项目开发流程。
分析类命令 :/sc:analyze
(代码分析)、/sc:troubleshoot
(调试排错)、/sc:explain
(代码解释)等,提供深度代码理解能力。
质量保证命令 :/sc:improve
(代码改进)、/sc:test
(测试策略)、/sc:cleanup
(代码清理)等,确保代码质量和可维护性。
9个认知人格系统
框架引入了专业化的 AI 人格,包括架构师、前端专家、后端专家、安全专家、分析师、QA专家、性能优化师、重构专家和导师等角色,每个人格都针对特定领域进行了优化。
高级特性
令牌优化技术 可实现70%的令牌使用量减少,MCP服务器集成 支持文档查询、多步推理、UI组件生成和浏览器自动化,基于证据的开发方法论要求所有建议都有官方文档支持。
安装和配置步骤
系统要求
- Python 3.8+ (框架核心要求)
- Claude Code(必须先安装并配置)
- Git(用于版本控制功能)
- 操作系统支持:Linux、macOS、Windows WSL
推荐工具:uv(用于包管理)。安装 uv:curl -Ls https://astral.sh/uv/install.sh | sh
。
安装步骤
安装分为两步:安装 Python 包,然后运行安装器配置 Claude。
-
安装 Python 包(推荐从 PyPI 安装):
-
使用 uv:
uv add SuperClaude
。 -
或者不使用 uv:
pip install SuperClaude
。 -
从源代码安装:
bashgit clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git cd SuperClaude_Framework uv sync
-
其他方式:创建虚拟环境
uv venv
,激活source .venv/bin/activate
(Windows 上为.venv\Scripts\activate
),然后uv pip install SuperClaude
。
-
-
运行安装器 (将框架文件复制到
~/.claude/
):- 快速安装(默认全功能):
SuperClaude install
或python3 -m SuperClaude install
。 - 交互模式(选择安装内容):
SuperClaude install --interactive
。 - 最小安装(仅核心功能):
SuperClaude install --minimal
。 - 开发者模式:
SuperClaude install --profile developer
。 - 查看帮助:
SuperClaude install --help
。
注意:如果是从 v2 升级,先卸载旧版并手动删除旧文件(如
SuperClaude/
目录和~/.claude/
中的内容)。 - 快速安装(默认全功能):
配置
- 安装后,
~/.claude/
目录会生成文件,如settings.json
(主配置文件,用于自定义行为,如令牌限制或 MCP 集成)和各种.md
文件(定义命令和角色)。 - 大多数用户无需修改,默认即可使用。如果需要自定义,编辑
settings.json
或.md
文件。
使用说明
安装完成后,在 Claude Code 的聊天界面(或支持的 IDE 插件)中使用框架:
- 命令前缀:
/sc:
(例如/sc:implement
)。 - 关键功能:
- 16 个专属命令:开发类(如
/sc:implement
实现功能、/sc:build
编译打包、/sc:design
系统设计);分析类(如/sc:analyze
代码审查、/sc:troubleshoot
调试、/sc:explain
解释代码);质量类(如/sc:improve
重构、/sc:test
写测试、/sc:cleanup
清理代码);其他(如/sc:document
生成文档、/sc:git
Git 操作、/sc:estimate
时间估算、/sc:task
任务管理)。 - 智能角色:自动选择专家角色,如"architect"(架构师)、"frontend"(前端开发者)、"backend"(后端)、"analyzer"(分析员)、"security"(安全专家)、"scribe"(文档专家)等。
- MCP 集成:支持外部工具,如 Context7(获取库文档)、Sequential(多步推理)、Magic(生成 UI 组件)、Playwright(浏览器自动化)。
- 任务管理:使用
/sc:task
拆解和跟踪任务。 - 令牌优化:帮助处理长对话。
- 16 个专属命令:开发类(如
安装配置选项
框架提供多种安装配置:
--quick
:快速安装(推荐90%用户使用)--interactive
:交互式选择组件--minimal
:最小化安装--profile developer
:开发者完整安装
配置文件结构
安装后会在 ~/.claude/
目录下创建完整的配置文件结构,包括主要的 CLAUDE.md 配置文件、命令定义文件、人格设定文件和MCP集成配置等。
基本使用方法和示例
快速入门流程
bash
# 查看可用命令
/sc:help
# 分析代码
/sc:analyze src/
# 实现新功能
/sc:implement user-auth
# 构建项目
/sc:build
# 改进代码质量
/sc:improve messy-file.js
人格增强命令示例
bash
# 架构分析
/sc:analyze --persona-architect --focus architecture
# 安全代码审查
/sc:analyze auth-system/ --persona-security
# 前端特定分析
/sc:analyze components/ --persona-frontend
# 性能优化
/sc:improve --persona-performance --focus performance
复杂工作流程示例
项目分析工作流:
bash
/sc:load --deep --summary # 加载项目上下文
/sc:analyze --focus quality --depth deep --persona-analyzer # 质量分析
/sc:analyze --focus architecture --persona-architect # 架构审查
/sc:document onboarding --type guide --persona-scribe # 生成文档
安全评估工作流:
bash
/sc:load auth-system/ --focus security # 加载认证系统
/sc:analyze --focus security --persona-security --depth deep # 安全分析
/sc:document security-analysis --type report --persona-security # 生成报告
/sc:improve --focus security --safe-mode --persona-security # 实施修复
框架的核心特性和优势
技术优势
零依赖性 :无需外部服务或数据库,完全本地运行确保数据隐私安全。令牌效率 通过智能压缩技术实现资源优化使用。模块化设计支持扩展模板系统,方便添加新功能。
开发工作流优势
上下文感知 能力维护项目上下文并从修正中学习,基于证据的方法论 要求提供证明和官方文档查询,专业化人格系统针对不同开发角色提供专门优化。
集成生态优势
MCP服务器集成 支持Context7文档查询、Sequential多步推理、Magic UI组件生成和Puppeteer浏览器自动化。Git集成提供检查点系统、智能提交消息生成和全面代码审查功能。
使用文档和教程资源
官方文档
- GitHub仓库 :github.com/NomenAK/Sup...
- 官方网站 :superclaude.org/
- 命令参考 :安装后可在
~/.claude/commands/
目录查看
学习资源
框架提供了全面的命令文档 、人格系统说明 、MCP集成指南 等。社区还提供了视频教程 、实际使用案例分享 和技术博客文章等丰富的学习材料。
社区支持
通过GitHub讨论区 、问题追踪系统 和社区贡献指南等渠道提供持续的技术支持和交流平台。
项目最新更新状态
当前版本状态
版本 :v3.0(2025年7月刚出测试版) 发布状态 :初始发布版本,持续改进中 PyPI发布:2025年7月23日最新发布
开发活动水平
项目显示高度活跃的开发状态 ,2025年7月有多次更新和问题修复,17个工作流运行 显示活跃的CI/CD流程,多个活跃的拉取请求包括PyPI打包改进和README更新。
社区参与度
- GitHub星标:约11.3k(显示强烈兴趣)
- 分支数量:约1k(表明活跃的社区参与)
- 维护者响应:@NomenAK、@mithun50等维护者积极响应社区问题
前置要求和依赖
必要前置条件
Python 3.8+ 是框架运行的核心要求,Claude Code 必须预先安装并配置(SuperClaude是对Claude Code的扩展),Git 需要配置用户信息以支持版本控制功能。
可选依赖
Node.js 18+ 用于MCP服务器支持(可选),GitHub CLI 用于增强的工作流程,SSH密钥 配置GitHub访问(推荐使用SSH而非HTTPS)。
平台兼容性
Linux 提供原生支持和自动shell检测,macOS 完全兼容Unix风格路径,Windows 通过WSL提供完整的Linux原生支持,同时支持Git Bash和PowerShell环境。
常见问题和注意事项
安装相关问题
Python版本问题 :确保使用Python 3.8+,可能需要使用 python
而非 python3
命令。权限问题 :检查 ~/.claude/
目录权限,必要时使用详细输出模式进行故障排除。安装位置问题:支持自定义安装目录和环境变量配置。
使用限制和注意事项
当前限制:目前仅支持Claude Code(v4计划支持更广泛兼容性),v3版本移除了钩子系统(正在为v4重新设计),某些命令效果可能优于其他命令。
稳定性评估
维护者明确表示"基本功能运行良好,但预期会有些粗糙边缘",建议用于实验和开发工作流程,暂不明确推荐用于生产环境。
最佳实践建议
从简单开始 :先使用基本命令熟悉框架,让SuperClaude自动选择工具 :观察自动激活的功能,然后尝试手动控制,批量处理相关工作:根据具体问题选择合适的作用域(文件级、模块级或项目级)。
实践例子:使用 /sc:implement
实现一个简单功能
假设你正在使用 Claude 的聊天界面开发一个 Python 脚本,需要实现一个用户认证功能。以下是实际操作步骤和例子:
-
准备:确保 SuperClaude 已安装并配置好。在 Claude 聊天中开始新对话。
-
输入命令:
- 在聊天框中输入:
/sc:implement Add user authentication to a simple Python web app using Flask. Include login and session management.
- 这会触发
/sc:implement
命令,Claude 会自动应用相关角色(如 backend 开发者),生成代码。
- 在聊天框中输入:
-
预期输出(Claude 会生成类似以下代码,并解释):
pythonfrom flask import Flask, request, session, redirect, url_for, render_template_string from werkzeug.security import generate_password_hash, check_password_hash app = Flask(__name__) app.secret_key = 'super_secret_key' # 实际中请使用随机密钥 # 模拟用户数据库 users = { 'user1': generate_password_hash('password1') } # 登录页面模板 login_html = ''' <form method="post"> Username: <input type="text" name="username"><br> Password: <input type="password" name="password"><br> <input type="submit" value="Login"> </form> ''' @app.route('/login', methods=['GET', 'POST']) def login(): if request.method == 'POST': username = request.form['username'] password = request.form['password'] if username in users and check_password_hash(users[username], password): session['user'] = username return redirect(url_for('home')) return 'Invalid credentials' return render_template_string(login_html) @app.route('/home') def home(): if 'user' in session: return f'Welcome, {session["user"]}!' return redirect(url_for('login')) @app.route('/logout') def logout(): session.pop('user', None) return redirect(url_for('login')) if __name__ == '__main__': app.run(debug=True)
-
后续操作:
- 如果需要分析生成的代码:在同一个对话中输入
/sc:analyze
(会自动审查代码)。 - 添加测试:输入
/sc:test Generate unit tests for the login function
。 - 如果遇到问题,使用
/sc:troubleshoot
调试。
- 如果需要分析生成的代码:在同一个对话中输入
这个例子展示了如何在实际开发中快速实现功能,框架会优化 Claude 的响应,使其更结构化和专业。如果需要更多自定义,编辑 ~/.claude/
中的文件。仓库处于早期版本,可能有 bug,建议通过 GitHub issues 反馈。
迁移注意事项
从v2升级到v3需要清理旧安装,删除相关目录,注意 /build
命令已更改为 /sc:implement
,需要更新使用习惯。
SuperClaude Framework 代表了AI辅助开发的重要进步,通过结构化工作流程、专家人格和全面项目管理能力,将Claude Code转变为专业的开发工具。虽然仍在发展中,但该框架为复杂的长期开发项目提供了成熟的方法,特别适合重视专业工作流程和一致质量结果的开发者使用。