External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-29 16:16:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
SuperClaude/README.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

523 lines
15 KiB
Markdown
Raw Blame History

<div align="center">
# 🚀 SuperClaude Framework
### **Transform Claude Code into a Structured Development Platform**
<p align="center">
<a href="https://github.com/hesreallyhim/awesome-claude-code/">
<img src="https://awesome.re/mentioned-badge-flat.svg" alt="Mentioned in Awesome Claude Code">
</a>
<a href="https://github.com/SuperClaude-Org/SuperGemini_Framework" target="_blank">
<img src="https://img.shields.io/badge/Try-SuperGemini_Framework-blue" alt="Try SuperGemini Framework"/>
</a>
<a href="https://github.com/SuperClaude-Org/SuperQwen_Framework" target="_blank">
<img src="https://img.shields.io/badge/Try-SuperQwen_Framework-orange" alt="Try SuperQwen Framework"/>
</a>
<img src="https://img.shields.io/badge/version-4.2.0-blue" alt="Version">
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License">
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome">
</p>
<p align="center">
<a href="https://superclaude.netlify.app/">
<img src="https://img.shields.io/badge/🌐_Visit_Website-blue" alt="Website">
</a>
<a href="https://pypi.org/project/superclaude/">
<img src="https://img.shields.io/pypi/v/SuperClaude.svg?" alt="PyPI">
</a>
<a href="https://pepy.tech/projects/superclaude">
<img src="https://static.pepy.tech/personalized-badge/superclaude?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads" alt="PyPI sats">
</a>
<a href="https://www.npmjs.com/package/@bifrost_inc/superclaude">
<img src="https://img.shields.io/npm/v/@bifrost_inc/superclaude.svg" alt="npm">
</a>
</p>
<p align="center">
<a href="README.md">
<img src="https://img.shields.io/badge/🇺🇸_English-blue" alt="English">
</a>
<a href="README-zh.md">
<img src="https://img.shields.io/badge/🇨🇳_中文-red" alt="中文">
</a>
<a href="README-ja.md">
<img src="https://img.shields.io/badge/🇯🇵_日本語-green" alt="日本語">
</a>
</p>
<p align="center">
<a href="#-quick-installation">Quick Start</a> •
<a href="#-support-the-project">Support</a> •
<a href="#-whats-new-in-v4">Features</a> •
<a href="#-documentation">Docs</a> •
<a href="#-contributing">Contributing</a>
</p>
</div>
---
<div align="center">
## 📊 **Framework Statistics**
| **Commands** | **Agents** | **Modes** | **MCP Servers** |
|:------------:|:----------:|:---------:|:---------------:|
| **26** | **16** | **7** | **8** |
| Slash Commands | Specialized AI | Behavioral | Integrations |
Use the new `/sc:help` command to see a full list of all available commands.
</div>
---
<div align="center">
## 🎯 **Overview**
SuperClaude is a **meta-programming configuration framework** that transforms Claude Code into a structured development platform through behavioral instruction injection and component orchestration. It provides systematic workflow automation with powerful tools and intelligent agents.
## Disclaimer
This project is not affiliated with or endorsed by Anthropic.
Claude Code is a product built and maintained by [Anthropic](https://www.anthropic.com/).
## ⚡ **Quick Installation**
### **Choose Your Installation Method**
| Method | Command | Best For |
|:------:|---------|----------|
| **🐍 pipx** | `pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install` | **✅ Recommended** - Linux/macOS |
| **📦 pip** | `pip install SuperClaude && pip upgrade SuperClaude && SuperClaude install` | Traditional Python environments |
| **🌐 npm** | `npm install -g @bifrost_inc/superclaude && superclaude install` | Cross-platform, Node.js users |
</div>
<details>
<summary><b>⚠️ IMPORTANT: Upgrading from SuperClaude V3</b></summary>
**If you have SuperClaude V3 installed, you SHOULD uninstall it before installing V4:**
```bash
# Uninstall V3 first
Remove all related files and directories :
*.md *.json and commands/
# Then install V4
pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install
```
**✅ What gets preserved during upgrade:**
- ✓ Your custom slash commands (outside `commands/sc/`)
- ✓ Your custom content in `CLAUDE.md`
- ✓ Claude Code's `.claude.json`, `.credentials.json`, `settings.json` and `settings.local.json`
- ✓ Any custom agents and files you've added
**⚠️ Note:** Other SuperClaude-related `.json` files from V3 may cause conflicts and should be removed.
</details>
<details>
<summary><b>💡 Troubleshooting PEP 668 Errors</b></summary>
```bash
# Option 1: Use pipx (Recommended)
pipx install SuperClaude
# Option 2: User installation
pip install --user SuperClaude
# Option 3: Force installation (use with caution)
pip install --break-system-packages SuperClaude
```
</details>
---
<div align="center">
## 💖 **Support the Project**
> Hey, let's be real - maintaining SuperClaude takes time and resources.
>
> *The Claude Max subscription alone runs $100/month for testing, and that's before counting the hours spent on documentation, bug fixes, and feature development.*
> *If you're finding value in SuperClaude for your daily work, consider supporting the project.*
> *Even a few dollars helps cover the basics and keeps development active.*
>
> Every contributor matters, whether through code, feedback, or support. Thanks for being part of this community! 🙏
<table>
<tr>
<td align="center" width="33%">
### ☕ **Ko-fi**
[![Ko-fi](https://img.shields.io/badge/Support_on-Ko--fi-ff5e5b?logo=ko-fi)](https://ko-fi.com/superclaude)
*One-time contributions*
</td>
<td align="center" width="33%">
### 🎯 **Patreon**
[![Patreon](https://img.shields.io/badge/Become_a-Patron-f96854?logo=patreon)](https://patreon.com/superclaude)
*Monthly support*
</td>
<td align="center" width="33%">
### 💜 **GitHub**
[![GitHub Sponsors](https://img.shields.io/badge/GitHub-Sponsor-30363D?logo=github-sponsors)](https://github.com/sponsors/SuperClaude-Org)
*Flexible tiers*
</td>
</tr>
</table>
### **Your Support Enables:**
| Item | Cost/Impact |
|------|-------------|
| 🔬 **Claude Max Testing** | $100/month for validation & testing |
| ⚡ **Feature Development** | New capabilities & improvements |
| 📚 **Documentation** | Comprehensive guides & examples |
| 🤝 **Community Support** | Quick issue responses & help |
| 🔧 **MCP Integration** | Testing new server connections |
| 🌐 **Infrastructure** | Hosting & deployment costs |
> **Note:** No pressure though - the framework stays open source regardless. Just knowing people use and appreciate it is motivating. Contributing code, documentation, or spreading the word helps too! 🙏
</div>
---
<div align="center">
## 🎉 **What's New in V4**
> *Version 4 brings significant improvements based on community feedback and real-world usage patterns.*
<table>
<tr>
<td width="50%">
### 🤖 **Smarter Agent System**
**16 specialized agents** with domain expertise:
- PM Agent ensures continuous learning through systematic documentation
- Deep Research agent for autonomous web research
- Security engineer catches real vulnerabilities
- Frontend architect understands UI patterns
- Automatic coordination based on context
- Domain-specific expertise on demand
</td>
<td width="50%">
### 📝 **Improved Namespace**
**`/sc:` prefix** for all commands:
- No conflicts with custom commands
- 25 commands covering full lifecycle
- From brainstorming to deployment
- Clean, organized command structure
</td>
</tr>
<tr>
<td width="50%">
### 🔧 **MCP Server Integration**
**8 powerful servers** working together:
- **Context7** → Up-to-date documentation
- **Sequential** → Complex analysis
- **Magic** → UI component generation
- **Playwright** → Browser testing
- **Morphllm** → Bulk transformations
- **Serena** → Session persistence
- **Tavily** → Web search for deep research
- **Chrome DevTools** → Performance analysis
</td>
<td width="50%">
### 🎯 **Behavioral Modes**
**7 adaptive modes** for different contexts:
- **Brainstorming** → Asks right questions
- **Business Panel** → Multi-expert strategic analysis
- **Deep Research** → Autonomous web research
- **Orchestration** → Efficient tool coordination
- **Token-Efficiency** → 30-50% context savings
- **Task Management** → Systematic organization
- **Introspection** → Meta-cognitive analysis
</td>
</tr>
<tr>
<td width="50%">
### ⚡ **Optimized Performance**
**Smaller framework, bigger projects:**
- Reduced framework footprint
- More context for your code
- Longer conversations possible
- Complex operations enabled
</td>
<td width="50%">
### 📚 **Documentation Overhaul**
**Complete rewrite** for developers:
- Real examples & use cases
- Common pitfalls documented
- Practical workflows included
- Better navigation structure
</td>
</tr>
</table>
</div>
---
<div align="center">
## 🔬 **Deep Research Capabilities**
### **Autonomous Web Research Aligned with DR Agent Architecture**
SuperClaude v4.2 introduces comprehensive Deep Research capabilities, enabling autonomous, adaptive, and intelligent web research.
<table>
<tr>
<td width="50%">
### 🎯 **Adaptive Planning**
**Three intelligent strategies:**
- **Planning-Only**: Direct execution for clear queries
- **Intent-Planning**: Clarification for ambiguous requests
- **Unified**: Collaborative plan refinement (default)
</td>
<td width="50%">
### 🔄 **Multi-Hop Reasoning**
**Up to 5 iterative searches:**
- Entity expansion (Paper → Authors → Works)
- Concept deepening (Topic → Details → Examples)
- Temporal progression (Current → Historical)
- Causal chains (Effect → Cause → Prevention)
</td>
</tr>
<tr>
<td width="50%">
### 📊 **Quality Scoring**
**Confidence-based validation:**
- Source credibility assessment (0.0-1.0)
- Coverage completeness tracking
- Synthesis coherence evaluation
- Minimum threshold: 0.6, Target: 0.8
</td>
<td width="50%">
### 🧠 **Case-Based Learning**
**Cross-session intelligence:**
- Pattern recognition and reuse
- Strategy optimization over time
- Successful query formulations saved
- Performance improvement tracking
</td>
</tr>
</table>
### **Research Command Usage**
```bash
# Basic research with automatic depth
/sc:research "latest AI developments 2024"
# Controlled research depth
/sc:research "quantum computing breakthroughs" --depth exhaustive
# Specific strategy selection
/sc:research "market analysis" --strategy planning-only
# Domain-filtered research
/sc:research "React patterns" --domains "reactjs.org,github.com"
```
### **Research Depth Levels**
| Depth | Sources | Hops | Time | Best For |
|:-----:|:-------:|:----:|:----:|----------|
| **Quick** | 5-10 | 1 | ~2min | Quick facts, simple queries |
| **Standard** | 10-20 | 3 | ~5min | General research (default) |
| **Deep** | 20-40 | 4 | ~8min | Comprehensive analysis |
| **Exhaustive** | 40+ | 5 | ~10min | Academic-level research |
### **Integrated Tool Orchestration**
The Deep Research system intelligently coordinates multiple tools:
- **Tavily MCP**: Primary web search and discovery
- **Playwright MCP**: Complex content extraction
- **Sequential MCP**: Multi-step reasoning and synthesis
- **Serena MCP**: Memory and learning persistence
- **Context7 MCP**: Technical documentation lookup
</div>
---
<div align="center">
## 📚 **Documentation**
### **Complete Guide to SuperClaude**
<table>
<tr>
<th align="center">🚀 Getting Started</th>
<th align="center">📖 User Guides</th>
<th align="center">🛠️ Developer Resources</th>
<th align="center">📋 Reference</th>
</tr>
<tr>
<td valign="top">
- 📝 [**Quick Start Guide**](docs/getting-started/quick-start.md)
*Get up and running fast*
- 💾 [**Installation Guide**](docs/getting-started/installation.md)
*Detailed setup instructions*
</td>
<td valign="top">
- 🎯 [**Commands Reference**](docs/user-guide/commands.md)
*All 25 slash commands*
- 🤖 [**Agents Guide**](docs/user-guide/agents.md)
*15 specialized agents*
- 🎨 [**Behavioral Modes**](docs/user-guide/modes.md)
*7 adaptive modes*
- 🚩 [**Flags Guide**](docs/user-guide/flags.md)
*Control behaviors*
- 🔧 [**MCP Servers**](docs/user-guide/mcp-servers.md)
*7 server integrations*
- 💼 [**Session Management**](docs/user-guide/session-management.md)
*Save & restore state*
</td>
<td valign="top">
- 🏗️ [**Technical Architecture**](docs/developer-guide/technical-architecture.md)
*System design details*
- 💻 [**Contributing Code**](docs/developer-guide/contributing-code.md)
*Development workflow*
- 🧪 [**Testing & Debugging**](docs/developer-guide/testing-debugging.md)
*Quality assurance*
</td>
<td valign="top">
- 📓 [**Examples Cookbook**](docs/reference/examples-cookbook.md)
*Real-world recipes*
- 🔍 [**Troubleshooting**](docs/reference/troubleshooting.md)
*Common issues & fixes*
</td>
</tr>
</table>
</div>
---
<div align="center">
## 🤝 **Contributing**
### **Join the SuperClaude Community**
We welcome contributions of all kinds! Here's how you can help:
| Priority | Area | Description |
|:--------:|------|-------------|
| 📝 **High** | Documentation | Improve guides, add examples, fix typos |
| 🔧 **High** | MCP Integration | Add server configs, test integrations |
| 🎯 **Medium** | Workflows | Create command patterns & recipes |
| 🧪 **Medium** | Testing | Add tests, validate features |
| 🌐 **Low** | i18n | Translate docs to other languages |
<p align="center">
<a href="CONTRIBUTING.md">
<img src="https://img.shields.io/badge/📖_Read-Contributing_Guide-blue" alt="Contributing Guide">
</a>
<a href="https://github.com/SuperClaude-Org/SuperClaude_Framework/graphs/contributors">
<img src="https://img.shields.io/badge/👥_View-All_Contributors-green" alt="Contributors">
</a>
</p>
</div>
---
<div align="center">
## ⚖️ **License**
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
<p align="center">
<img src="https://img.shields.io/badge/License-MIT-yellow.svg?" alt="MIT License">
</p>
</div>
---
<div align="center">
## ⭐ **Star History**
<a href="https://www.star-history.com/#SuperClaude-Org/SuperClaude_Framework&Timeline">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=SuperClaude-Org/SuperClaude_Framework&type=Timeline" />
</picture>
</a>
</div>
---
<div align="center">
### **🚀 Built with passion by the SuperClaude community**
<p align="center">
<sub>Made with ❤️ for developers who push boundaries</sub>
</p>
<p align="center">
<a href="#-superclaude-framework">Back to Top ↑</a>
</p>
</div>
Reference in New Issue View Git Blame Copy Permalink