From 84b49a7ff5149275c49a9368490a10ebd19e3c35 Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:34:48 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 646 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 646 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..ef8c5ad --- /dev/null +++ b/README.en.md @@ -0,0 +1,646 @@ +
+ +# πŸš€ SuperClaude Framework + +[![Run in Smithery](https://smithery.ai/badge/skills/SuperClaude-Org)](https://smithery.ai/skills?ns=SuperClaude-Org&utm_source=github&utm_medium=badge) + + +### **Transform Claude Code into a Structured Development Platform** + +

+ + Mentioned in Awesome Claude Code + + + Try SuperGemini Framework + + + Try SuperQwen Framework + + Version + + Tests + + License + PRs Welcome +

+ +

+ + Website + + + PyPI + + + PyPI sats + + + npm + +

+ +

+ + English + + + δΈ­ζ–‡ + + + ζ—₯本θͺž + +

+ +

+ Quick Start β€’ + Support β€’ + Features β€’ + Docs β€’ + Contributing +

+ +
+ +--- + +
+ +## πŸ“Š **Framework Statistics** + +| **Commands** | **Agents** | **Modes** | **MCP Servers** | +|:------------:|:----------:|:---------:|:---------------:| +| **30** | **20** | **7** | **8** | +| Slash Commands | Specialized AI | Behavioral | Integrations | + +30 slash commands covering the complete development lifecycle from brainstorming to deployment. + +
+ +--- + +
+ +## 🎯 **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/). + +## πŸ“– **For Developers & Contributors** + +**Essential documentation for working with SuperClaude Framework:** + +| Document | Purpose | When to Read | +|----------|---------|--------------| +| **[PLANNING.md](PLANNING.md)** | Architecture, design principles, absolute rules | Session start, before implementation | +| **[TASK.md](TASK.md)** | Current tasks, priorities, backlog | Daily, before starting work | +| **[KNOWLEDGE.md](KNOWLEDGE.md)** | Accumulated insights, best practices, troubleshooting | When encountering issues, learning patterns | +| **[CONTRIBUTING.md](CONTRIBUTING.md)** | Contribution guidelines, workflow | Before submitting PRs | +| **[Commands Reference](docs/user-guide/commands.md)** | Complete reference for all 30 `/sc:*` commands with syntax, examples, workflows, and decision guides | Learning SuperClaude, choosing the right command | + +> **πŸ’‘ Pro Tip**: Claude Code reads these files at session start to ensure consistent, high-quality development aligned with project standards. +> +> **πŸ“š New to SuperClaude?** Start with [Commands Reference](docs/user-guide/commands.md) β€” it contains visual decision trees, detailed command comparisons, and workflow examples to help you understand which commands to use and when. + +## ⚑ **Quick Installation** + +> **IMPORTANT**: The TypeScript plugin system described in older documentation is +> not yet available (planned for v5.0). For current installation +> instructions, please follow the steps below for v4.x. + +### **Current Stable Version (v4.3.0)** + +SuperClaude currently uses slash commands. + +**Option 1: pipx (Recommended)** +```bash +# Install from PyPI +pipx install superclaude + +# Install commands (installs all 30 slash commands) +superclaude install + +# Install MCP servers (optional, for enhanced capabilities) +superclaude mcp --list # List available MCP servers +superclaude mcp # Interactive installation +superclaude mcp --servers tavily --servers context7 # Install specific servers + +# Verify installation +superclaude install --list +superclaude doctor +``` + +After installation, restart Claude Code to use 30 commands including: +- `/sc:research` - Deep web research (enhanced with Tavily MCP) +- `/sc:brainstorm` - Structured brainstorming +- `/sc:implement` - Code implementation +- `/sc:test` - Testing workflows +- `/sc:pm` - Project management +- `/sc` - Show all 30 available commands + +**Option 2: Direct Installation from Git** +```bash +# Clone the repository +git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git +cd SuperClaude_Framework + +# Run the installation script +./install.sh +``` + +### **Coming in v5.0 (In Development)** + +We are actively working on a new TypeScript plugin system (see issue [#419](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues/419) for details). When released, installation will be simplified to: + +```bash +# This feature is not yet available +/plugin marketplace add SuperClaude-Org/superclaude-plugin-marketplace +/plugin install superclaude +``` + +**Status**: In development. No ETA has been set. + +### **Enhanced Performance (Optional MCPs)** + +For **2-3x faster** execution and **30-50% fewer tokens**, optionally install MCP servers: + +```bash +# Optional MCP servers for enhanced performance (via airis-mcp-gateway): +# - Serena: Code understanding (2-3x faster) +# - Sequential: Token-efficient reasoning (30-50% fewer tokens) +# - Tavily: Web search for Deep Research +# - Context7: Official documentation lookup +# - Mindbase: Semantic search across all conversations (optional enhancement) + +# Note: Error learning available via built-in ReflexionMemory (no installation required) +# Mindbase provides semantic search enhancement (requires "recommended" profile) +# Install MCP servers: https://github.com/agiletec-inc/airis-mcp-gateway +# See docs/mcp/mcp-integration-policy.md for details +``` + +**Performance Comparison:** +- **Without MCPs**: Fully functional, standard performance βœ… +- **With MCPs**: 2-3x faster, 30-50% fewer tokens ⚑ + +
+ +--- + +
+ +## πŸ’– **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! πŸ™ + + + + + + + +
+ +### β˜• **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* + + + +### 🎯 **Patreon** +[![Patreon](https://img.shields.io/badge/Become_a-Patron-f96854?logo=patreon)](https://patreon.com/superclaude) + +*Monthly support* + + + +### πŸ’œ **GitHub** +[![GitHub Sponsors](https://img.shields.io/badge/GitHub-Sponsor-30363D?logo=github-sponsors)](https://github.com/sponsors/SuperClaude-Org) + +*Flexible tiers* + +
+ +### **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! πŸ™ + +
+ +--- + +
+ +## πŸŽ‰ **What's New in v4.1** + +> *Version 4.1 focuses on stabilizing the slash command architecture, enhancing agent capabilities, and improving documentation.* + + + + + + + + + + + + + + +
+ +### πŸ€– **Smarter Agent System** +**20 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 + + + +### ⚑ **Optimized Performance** +**Smaller framework, bigger projects:** +- Reduced framework footprint +- More context for your code +- Longer conversations possible +- Complex operations enabled + +
+ +### πŸ”§ **MCP Server Integration** +**8 powerful servers** with easy CLI installation: + +```bash +# List available MCP servers +superclaude mcp --list + +# Install specific servers +superclaude mcp --servers tavily context7 + +# Interactive installation +superclaude mcp +``` + +**Available servers:** +- **Tavily** β†’ Primary web search (Deep Research) +- **Context7** β†’ Official documentation lookup +- **Sequential-Thinking** β†’ Multi-step reasoning +- **Serena** β†’ Session persistence & memory +- **Playwright** β†’ Cross-browser automation +- **Magic** β†’ UI component generation +- **Morphllm-Fast-Apply** β†’ Context-aware code modifications +- **Chrome DevTools** β†’ Performance analysis + + + +### 🎯 **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 + +
+ +### πŸ“š **Documentation Overhaul** +**Complete rewrite** for developers: +- Real examples & use cases +- Common pitfalls documented +- Practical workflows included +- Better navigation structure + + + +### πŸ§ͺ **Enhanced Stability** +**Focus on reliability:** +- Bug fixes for core commands +- Improved test coverage +- More robust error handling +- CI/CD pipeline improvements + +
+ +
+ +--- + +
+ +## πŸ”¬ **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. + + + + + + + + + + +
+ +### 🎯 **Adaptive Planning** +**Three intelligent strategies:** +- **Planning-Only**: Direct execution for clear queries +- **Intent-Planning**: Clarification for ambiguous requests +- **Unified**: Collaborative plan refinement (default) + + + +### πŸ”„ **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) + +
+ +### πŸ“Š **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 + + + +### 🧠 **Case-Based Learning** +**Cross-session intelligence:** +- Pattern recognition and reuse +- Strategy optimization over time +- Successful query formulations saved +- Performance improvement tracking + +
+ +### **Research Command Usage** + +```bash +# Basic research with automatic depth +/research "latest AI developments 2024" + +# Controlled research depth (via options in TypeScript) +/research "quantum computing breakthroughs" # depth: exhaustive + +# Specific strategy selection +/research "market analysis" # strategy: planning-only + +# Domain-filtered research (Tavily MCP integration) +/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 + +
+ +--- + +
+ +## πŸ“š **Documentation** + +### **Complete Guide to SuperClaude** + + + + + + + + + + + + + + +
πŸš€ Getting StartedπŸ“– User GuidesπŸ› οΈ Developer ResourcesπŸ“‹ Reference
+ +- πŸ“ [**Quick Start Guide**](docs/getting-started/quick-start.md) + *Get up and running fast* + +- πŸ’Ύ [**Installation Guide**](docs/getting-started/installation.md) + *Detailed setup instructions* + + + +- 🎯 [**Slash Commands**](docs/reference/commands-list.md) + *All 30 commands organized by category* + +- πŸ€– [**Agents Guide**](docs/user-guide/agents.md) + *20 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) + *8 server integrations* + +- πŸ’Ό [**Session Management**](docs/user-guide/session-management.md) + *Save & restore state* + + + +- πŸ—οΈ [**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* + + +- πŸ““ [**Examples Cookbook**](docs/reference/examples-cookbook.md) + *Real-world recipes* + +- πŸ” [**Troubleshooting**](docs/reference/troubleshooting.md) + *Common issues & fixes* + +
+ +
+ +--- + +
+ +## 🀝 **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 | + +

+ + Contributing Guide + + + Contributors + +

+ +
+ +--- + +
+ +## βš–οΈ **License** + +This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details. + +

+ MIT License +

+ +
+ +--- + +
+ +## ⭐ **Star History** + + + + + + Star History Chart + + + + +
+ +--- + +
+ +### **πŸš€ Built with passion by the SuperClaude community** + +

+ Made with ❀️ for developers who push boundaries +

+ +

+ Back to Top ↑ +

+ +
+ +--- + +## πŸ“‹ **All 30 Commands** + +
+Click to expand full command list + +### 🧠 Planning & Design (4) +- `/brainstorm` - Structured brainstorming +- `/design` - System architecture +- `/estimate` - Time/effort estimation +- `/spec-panel` - Specification analysis + +### πŸ’» Development (5) +- `/implement` - Code implementation +- `/build` - Build workflows +- `/improve` - Code improvements +- `/cleanup` - Refactoring +- `/explain` - Code explanation + +### πŸ§ͺ Testing & Quality (4) +- `/test` - Test generation +- `/analyze` - Code analysis +- `/troubleshoot` - Debugging +- `/reflect` - Retrospectives + +### πŸ“š Documentation (2) +- `/document` - Doc generation +- `/help` - Command help + +### πŸ”§ Version Control (1) +- `/git` - Git operations + +### πŸ“Š Project Management (3) +- `/pm` - Project management +- `/task` - Task tracking +- `/workflow` - Workflow automation + +### πŸ” Research & Analysis (2) +- `/research` - Deep web research +- `/business-panel` - Business analysis + +### 🎯 Utilities (9) +- `/agent` - AI agents +- `/index-repo` - Repository indexing +- `/index` - Indexing alias +- `/recommend` - Command recommendations +- `/select-tool` - Tool selection +- `/spawn` - Parallel tasks +- `/load` - Load sessions +- `/save` - Save sessions +- `/sc` - Show all commands + +[**πŸ“– View Detailed Command Reference β†’**](docs/reference/commands-list.md) + +
+