SuperClaude/README-zh.md
kazuki nakai d5dfd7da21
refactor(docs): normalize documentation naming to lowercase for PEP8 compliance (#434)
* refactor(docs): rename directories to lowercase for PEP8 compliance

- Developer-Guide → developer-guide
- Getting-Started → getting-started
- Reference → reference
- Templates → templates
- User-Guide → user-guide
- User-Guide-jp → user-guide-jp
- User-Guide-kr → user-guide-kr
- User-Guide-zh → user-guide-zh

This change aligns with Python PEP8 package naming conventions.
All 43 files affected.

* refactor: rename root documentation files to lowercase

- CHANGELOG.md → changelog.md
- CODE_OF_CONDUCT.md → code_of_conduct.md
- CONTRIBUTING.md → contributing.md
- SECURITY.md → security.md

Aligns with Python package naming conventions (PEP8).
README files remain uppercase as per convention.

* refactor: move documentation files to docs/ for cleaner root

Moved OSS standard files to docs/:
- CHANGELOG.md → docs/CHANGELOG.md
- CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md
- CONTRIBUTING.md → docs/CONTRIBUTING.md
- SECURITY.md → docs/SECURITY.md

Root now contains only essential files:
✓ README files (表紙: en, ja, kr, zh)
✓ LICENSE (法的要件)
✓ Build configs (pyproject.toml, setup.py, MANIFEST.in)
✓ VERSION

Rationale:
Cleaner root structure following modern Python project conventions.
All detailed documentation consolidated in docs/ directory.

* refactor: update documentation links after restructure

Auto-updated internal documentation links to reflect new structure:
- docs/ subdirectories now lowercase (PEP8)
- Root files moved to docs/
- All cross-references updated

This commit includes linter-generated link updates.

* chore(docs): keep OSS-standard uppercase root files (CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY)

* chore(docs): remove duplicated PR docs from repo root (moved under docs)

* docs: rename pm-agent-implementation-status.md -> PM_AGENT.md for clarity

* docs: update links to PM_AGENT.md after rename

---------

Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
2025-10-15 21:07:39 +05:30

10 KiB
Raw Blame History

🚀 SuperClaude 框架

将Claude Code转换为结构化开发平台

Version License PRs Welcome

Website PyPI npm

English 中文 日本語

快速开始支持项目新功能文档贡献


📊 框架统计

命令数 智能体 模式 MCP服务器
21 14 5 6
斜杠命令 专业AI 行为模式 集成服务

🎯 概述

SuperClaude是一个元编程配置框架通过行为指令注入和组件编排将Claude Code转换为结构化开发平台。它提供系统化的工作流自动化配备强大的工具和智能代理。

快速安装

选择您的安装方式

方式 命令 最适合
🐍 pipx pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install 推荐 - Linux/macOS
📦 pip pip install SuperClaude && pip upgrade SuperClaude && SuperClaude install 传统Python环境
🌐 npm npm install -g @bifrost_inc/superclaude && superclaude install 跨平台Node.js用户
⚠️ 重要从SuperClaude V3升级

如果您已安装SuperClaude V3应在安装V4前先卸载它

# 先卸载V3
删除所有相关文件和目录:
*.md *.json 和 commands/

# 然后安装V4
pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install

升级时保留的内容:

  • ✓ 您的自定义斜杠命令(commands/sc/之外的)
  • ✓ 您在CLAUDE.md中的自定义内容
  • ✓ Claude Code的.claude.json.credentials.jsonsettings.jsonsettings.local.json
  • ✓ 您添加的任何自定义代理和文件

⚠️ 注意: V3的其他SuperClaude相关.json文件可能会造成冲突,应当移除。

💡 PEP 668错误故障排除
# 选项1使用pipx推荐
pipx install SuperClaude

# 选项2用户安装
pip install --user SuperClaude

# 选项3强制安装谨慎使用
pip install --break-system-packages SuperClaude

💖 支持项目

说实话维护SuperClaude需要时间和资源。

仅Claude Max订阅每月就要100美元用于测试这还不包括在文档、bug修复和功能开发上花费的时间。 如果您在日常工作中发现SuperClaude的价值请考虑支持这个项目。 哪怕几美元也能帮助覆盖基础成本并保持开发活跃。

每个贡献者都很重要,无论是代码、反馈还是支持。感谢成为这个社区的一员!🙏

Ko-fi

Ko-fi

一次性贡献

🎯 Patreon

Patreon

月度支持

💜 GitHub

GitHub Sponsors

灵活层级

您的支持使以下工作成为可能:

项目 成本/影响
🔬 Claude Max测试 每月100美元用于验证和测试
功能开发 新功能和改进
📚 文档编写 全面的指南和示例
🤝 社区支持 快速问题响应和帮助
🔧 MCP集成 测试新服务器连接
🌐 基础设施 托管和部署成本

注意: 不过没有压力——无论如何框架都会保持开源。仅仅知道有人在使用和欣赏它就很有激励作用。贡献代码、文档或传播消息也很有帮助!🙏


🎉 V4版本新功能

第4版基于社区反馈和实际使用模式带来了重大改进。

🤖 更智能的代理系统

14个专业代理,具有领域专业知识:

  • 安全工程师发现真实漏洞
  • 前端架构师理解UI模式
  • 基于上下文的自动协调
  • 按需提供领域专业知识

📝 改进的命名空间

/sc:前缀用于所有命令:

  • 与自定义命令无冲突
  • 21个命令覆盖完整生命周期
  • 从头脑风暴到部署
  • 清晰有序的命令结构

🔧 MCP服务器集成

6个强大服务器协同工作:

  • Context7 → 最新文档
  • Sequential → 复杂分析
  • Magic → UI组件生成
  • Playwright → 浏览器测试
  • Morphllm → 批量转换
  • Serena → 会话持久化

🎯 行为模式

5种自适应模式适应不同上下文:

  • 头脑风暴 → 提出正确问题
  • 编排 → 高效工具协调
  • 令牌效率 → 30-50%上下文节省
  • 任务管理 → 系统化组织
  • 内省 → 元认知分析

优化性能

更小的框架,更大的项目:

  • 减少框架占用
  • 为您的代码提供更多上下文
  • 支持更长对话
  • 启用复杂操作

📚 文档全面改写

为开发者完全重写:

  • 真实示例和用例
  • 记录常见陷阱
  • 包含实用工作流
  • 更好的导航结构

📚 Documentation

Complete Guide to SuperClaude

🚀 快速开始 📖 用户指南 🛠️ 开发资源 📋 参考资料

🤝 贡献

加入SuperClaude社区

我们欢迎各种类型的贡献!以下是您可以帮助的方式:

优先级 领域 描述
📝 文档 改进指南,添加示例,修复错误
🔧 MCP集成 添加服务器配置,测试集成
🎯 工作流 创建命令模式和配方
🧪 测试 添加测试,验证功能
🌐 国际化 将文档翻译为其他语言

Contributing Guide Contributors


⚖️ 许可证

本项目基于MIT许可证授权 - 详情请参阅LICENSE文件。

MIT License


Star历史

Star History Chart

🚀 由SuperClaude社区倾情打造

为突破边界的开发者用❤️制作

返回顶部 ↑