SuperClaude 中文帮助文档

简介

SuperClaude 是一款结合 Claude AI 能力的 GitHub 工作流增强工具，能够显著提升开发效率。它可以生成智能提交信息、创建可读性强的变更日志、自动生成文档以及进行代码审查，帮助开发者专注于代码本身而非繁琐的文档工作。

核心功能

• AI 驱动的提交信息：分析代码变更，生成符合规范且有意义的提交信息
• 智能变更日志：将原始提交历史转换为可读性强的项目更新记录
• 自动文档生成：分析代码库结构，创建专业的 README 和技术文档
• 代码审查：检测安全漏洞、性能问题和可维护性问题
• 项目集成：轻松融入现有开发流程，支持团队协作

安装指南

前提条件

• Node.js 18+
• Git
• Claude Code（安装指南）
• （可选）GitHub CLI

安装步骤

1. 安装 Claude Code（如未安装）：

   npm install -g @anthropic-ai/claude-code
   claude  # 完成身份验证
   

2. 安装 SuperClaude：

   npm install -g superclaude
   

3. （推荐）安装 GitHub CLI 并进行身份验证：

   # macOS
   brew install gh
   
   # 身份验证
   gh auth login
   

快速开始

# 检查系统设置和身份验证状态
superclaude --verify

# 进行 AI 驱动的提交
superclaude commit

# 生成智能变更日志
superclaude changelog

# 自动更新 README 文档
superclaude readme

命令详解

🔧 superclaude --verify

智能依赖和身份验证检查工具，确保 Claude、Git 和 GitHub 身份验证正确配置。

superclaude --verify                  # 执行完整依赖检查

功能：

• 验证 Claude Code 安装和身份验证状态
• 检查 Git 配置和用户设置
• 验证 GitHub 身份验证（SSH 密钥或 GitHub CLI）
• 使用智能 24 小时缓存避免重复检查
• 提供详细的缺失依赖项反馈

🤖 superclaude commit

AI 驱动的提交信息生成工具，分析代码变更并生成有意义的提交信息。

superclaude commit                    # 快速 AI 提交
superclaude commit --interactive      # 提交前查看并确认
superclaude commit --verbose          # 查看 AI 思考过程
superclaude commit "添加用户上下文"    # 包含额外上下文信息

工作原理：

• 扫描所有更改文件并理解修改内容
• 分析代码模式以确定提交类型（feat/fix/refactor 等）
• 生成符合规范的提交格式和清晰描述
• 支持附加上下文以指导提交信息生成
• 自动暂存、提交并推送到当前分支

📅 superclaude changelog

将原始提交历史转换为可读性强的项目更新记录，专注于用户影响而非技术细节。

superclaude changelog                 # 生成智能变更日志
superclaude changelog --verbose       # 查看详细分析过程

工作原理：

• 使用 AI 分析整个提交历史
• 过滤琐碎变更，专注于有意义的更新
• 按时间段和影响分组变更
• 创建多种变更日志格式（每日/每周/每月）
• 以清晰、非技术语言编写

📖 superclaude readme

分析代码库架构并创建全面的 README 文件，包含安装指南、使用示例和功能描述。

superclaude readme                    # 生成项目 README

工作原理：

• 扫描项目结构并识别关键技术
• 分析 package.json 和依赖关系
• 理解代码模式和项目目的
• 创建带示例的专业文档
• 包含安装、使用和贡献指南

🔍 superclaude review

执行深度代码分析，检查安全漏洞、性能问题和可维护性问题，提供可操作的改进建议。

superclaude review                    # 全面代码分析
superclaude review --verbose          # 详细安全评估

工作原理：

• 分析整个代码库的模式和反模式
• 识别安全漏洞和性能瓶颈
• 评估代码质量和可维护性指标
• 提供具体、可操作的改进建议
• 将详细审查结果保存到 docs/code-review.md

📚 superclaude docs

创建全面的技术指南，涵盖架构、组件、部署和故障排除。

superclaude docs                      # 生成技术文档

工作原理：

• 映射项目架构和组件关系
• 记录数据流和系统交互
• 创建部署和配置指南
• 包含故障排除和调试信息
• 保存到 docs/technical-docs.md

💡 superclaude brainstorm

AI 驱动的功能构思和改进建议工具，分析代码库功能并提出新功能、优化和架构改进建议。

superclaude brainstorm                # 获取改进想法

工作原理：

• 评估当前代码库功能和模式
• 识别优化机会和技术债务
• 基于项目方向建议新功能
• 推荐架构演进策略
• 将想法保存到 docs/ideas.md

📝 superclaude annotate

为整个 Git 历史添加智能上下文，分析存储库中的每个提交并添加 AI 生成的注释，解释每次更改的实际成果。

superclaude annotate                  # 为所有提交添加 AI 注释
superclaude annotate --verbose        # 查看注释过程

工作原理：

• 处理每个提交的差异并理解更改
• 生成详细的技术解释
• 添加带有上下文和目的的 Git 注释
• 创建可搜索的提交历史
• 使用 git log --show-notes 查看注释

项目集成

将以下内容添加到 package.json 以实现团队工作流：

{
  "scripts": {
    "commit": "superclaude commit --interactive",
    "release:prep": "superclaude changelog && superclaude readme",
    "code:review": "superclaude review --verbose",
    "docs:update": "superclaude docs"
  }
}

使用示例

日常工作流

# 进行一些代码更改
echo "新功能" >> src/feature.js

# AI 提交，生成完美的提交信息
superclaude commit
# ✅ 输出: "feat: 添加基于 JWT 的用户认证"

# 自动更新文档
superclaude readme
# ✅ 创建包含新功能文档的专业 README

# 准备发布
superclaude changelog
# ✅ 生成利益相关者能够理解的发布说明

团队工作流

# 站会前 - 获取项目洞察
superclaude brainstorm
# ✅ "基于您的代码库，这里有 8 个改进机会..."

# 发布前 - 全面准备
yarn release:prep
# ✅ 更新变更日志 + README + 文档

# 代码审查前 - AI 预筛选
superclaude review
# ✅ "发现 3 个安全问题和 5 个性能优化..."

常见问题

命令未找到

npm install -g superclaude
# 确保 npm 全局 bin 目录在您的 PATH 中

Claude Code 未认证

claude
# 按照认证提示操作（Console/Pro/Enterprise）

Git 未配置

git config --global user.name "您的姓名"
git config --global user.email "your@email.com"

GitHub CLI 问题（可选）

brew install gh         # macOS 推荐
gh auth login          # 与 GitHub 进行身份验证

调试模式

使用 --verbose 获取详细输出，使用 --verify 进行依赖检查：

superclaude commit --verbose          # 显示 AI 逐步推理过程
superclaude --verify                  # 强制完整系统验证
superclaude --verify --verbose        # 详细依赖诊断

获取帮助

• 运行 superclaude help 获取命令参考
• 查看 Claude Code 文档
• 在 GitHub 上提交问题

贡献指南

1. Fork 仓库
2. 进行更改
3. 使用 SuperClaude 提交：superclaude commit --interactive
4. 提交拉取请求

许可证

MIT 许可证 - 详见 LICENSE 文件。