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
2025-10-14 08:51:16 +05:30
2025-08-22 20:39:46 +02:00
2025-09-26 19:37:34 +05:30
2025-08-26 20:30:50 +05:30
2025-10-14 08:56:00 +05:30
2025-09-26 19:37:34 +05:30
2025-10-14 14:51:52 +05:30
2025-10-14 15:04:44 +05:30

🚀 SuperClaude Framework

Transform Claude Code into a Structured Development Platform

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

Website PyPI PyPI sats npm

English 中文 日本語

Quick StartSupportFeaturesDocsContributing


📊 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.


🎯 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.

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
⚠️ IMPORTANT: Upgrading from SuperClaude V3

If you have SuperClaude V3 installed, you SHOULD uninstall it before installing V4:

# 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.

💡 Troubleshooting PEP 668 Errors
# 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

💖 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

One-time contributions

🎯 Patreon

Patreon

Monthly support

💜 GitHub

GitHub Sponsors

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

Version 4 brings significant improvements based on community feedback and real-world usage patterns.

🤖 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

📝 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

🔧 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

🎯 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

Optimized Performance

Smaller framework, bigger projects:

  • Reduced framework footprint
  • More context for your code
  • Longer conversations possible
  • Complex operations enabled

📚 Documentation Overhaul

Complete rewrite for developers:

  • Real examples & use cases
  • Common pitfalls documented
  • Practical workflows included
  • Better navigation structure

🔬 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

# 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

📚 Documentation

Complete Guide to SuperClaude

🚀 Getting Started 📖 User Guides 🛠️ Developer Resources 📋 Reference
- 📓 [**Examples Cookbook**](docs/reference/examples-cookbook.md) *Real-world recipes*

🤝 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 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 ↑

Description
A configuration framework that enhances Claude Code with specialized commands, cognitive personas, and development methodologies.
Readme MIT 17 MiB
Languages
Python 75.2%
TypeScript 13.7%
Shell 9%
Makefile 2.1%