Skip to content

SuperClaude-Org/SuperClaude_Framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

94 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

SuperClaude v3 ๐Ÿš€

Website Preview License: MIT PyPI version Version GitHub issues PRs Welcome Contributors Website

A framework that extends Claude Code with specialized commands, personas, and MCP server integration.

๐Ÿ“ข Status: Initial release, fresh out of beta! Bugs may occur as we continue improving things.

What is SuperClaude? ๐Ÿค”

SuperClaude tries to make Claude Code more helpful for development work by adding:

  • ๐Ÿ› ๏ธ 16 specialized commands for common dev tasks (some work better than others!)
  • ๐ŸŽญ Smart personas that usually pick the right expert for different domains
  • ๐Ÿ”ง MCP server integration for docs, UI components, and browser automation
  • ๐Ÿ“‹ Task management that tries to keep track of progress
  • โšก Token optimization to help with longer conversations

This is what we've been building to make development workflows smoother. Still rough around the edges, but getting better! ๐Ÿ˜Š

Current Status ๐Ÿ“Š

โœ… What's Working Well:

  • Installation suite (rewritten from the ground up)
  • Core framework with 9 documentation files
  • 16 slash commands for various development tasks
  • MCP server integration (Context7, Sequential, Magic, Playwright)
  • Unified CLI installer for easy setup

โš ๏ธ Known Issues:

  • This is an initial release - bugs are expected
  • Some features may not work perfectly yet
  • Documentation is still being improved
  • Hooks system was removed (coming back in v4)

Key Features โœจ

Commands ๐Ÿ› ๏ธ

We focused on 16 essential commands for the most common tasks:

Development: /sc:implement, /sc:build, /sc:design
Analysis: /sc:analyze, /sc:troubleshoot, /sc:explain
Quality: /sc:improve, /sc:test, /sc:cleanup
Others: /sc:document, /sc:git, /sc:estimate, /sc:task, /sc:index, /sc:load, /sc:spawn

Smart Personas ๐ŸŽญ

AI specialists that try to jump in when they seem relevant:

  • ๐Ÿ—๏ธ architect - Systems design and architecture stuff
  • ๐ŸŽจ frontend - UI/UX and accessibility
  • โš™๏ธ backend - APIs and infrastructure
  • ๐Ÿ” analyzer - Debugging and figuring things out
  • ๐Ÿ›ก๏ธ security - Security concerns and vulnerabilities
  • โœ๏ธ scribe - Documentation and writing
  • ...and 5 more specialists

(They don't always pick perfectly, but usually get it right!)

MCP Integration ๐Ÿ”ง

External tools that connect when useful:

  • Context7 - Grabs official library docs and patterns
  • Sequential - Helps with complex multi-step thinking
  • Magic - Generates modern UI components
  • Playwright - Browser automation and testing stuff

(These work pretty well when they connect properly! ๐Ÿคž)

โš ๏ธ Upgrading from v2? Important!

If you're coming from SuperClaude v2, you'll need to clean up first:

  1. Uninstall v2 using its uninstaller if available
  2. Manual cleanup - delete these if they exist:
    • SuperClaude/
    • ~/.claude/shared/
    • ~/.claude/commands/
    • ~/.claude/CLAUDE.md
  3. Then proceed with v3 installation below

This is because v3 has a different structure and the old files can cause conflicts.

๐Ÿ”„ Key Change for v2 Users

The /build command changed! In v2, /build was used for feature implementation. In v3:

  • /sc:build = compilation/packaging only
  • /sc:implement = feature implementation (NEW!)

Migration: Replace v2 /build myFeature with v3 /sc:implement myFeature

Installation ๐Ÿ“ฆ

SuperClaude installation is a two-step process:

  1. First install the Python package
  2. Then run the installer to set up Claude Code integration

Step 1: Install the Package

Option A: From PyPI (Recommended)

uv add SuperClaude

Option B: From Source

git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git
cd SuperClaude
uv sync

๐Ÿ”ง UV / UVX Setup Guide

SuperClaude v3 also supports installation via uv (a faster, modern Python package manager) or uvx for cross-platform usage.

๐ŸŒ€ Install with uv

Make sure uv is installed:

curl -Ls https://astral.sh/uv/install.sh | sh

Or follow instructions from: https://github.com/astral-sh/uv

Once uv is available, you can install SuperClaude like this:

uv venv
source .venv/bin/activate
uv pip install SuperClaude

โšก Install with uvx (Cross-platform CLI)

If youโ€™re using uvx, just run:

uvx pip install SuperClaude

โœ… Finish Installation

After installing, continue with the usual installer step:

python3 -m SuperClaude install

Or using bash-style CLI:

SuperClaude install

๐Ÿง  Note:

  • uv provides better caching and performance.
  • Compatible with Python 3.8+ and works smoothly with SuperClaude.

Missing Python? Install Python 3.7+ first:

# Linux (Ubuntu/Debian)
sudo apt update && sudo apt install python3 python3-pip

# macOS  
brew install python3

# Windows
# Download from https://python.org/downloads/

Step 2: Run the Installer

After installing the package, run the SuperClaude installer to configure Claude Code (You can use any of the method):

โš ๏ธ Important Note

After installing the SuperClaude. You can use SuperClaude commands , python3 -m SuperClaude commands or also python3 SuperClaude commands

# Quick setup (recommended for most users)
python3 SuperClaude install

# Interactive selection (choose components)
python3 SuperClaude install --interactive

# Minimal install (just core framework)
python3 SuperClaude install --minimal

# Developer setup (everything included)
python3 SuperClaude install --profile developer

# See all available options
python3 SuperClaude install --help

Or Python Modular Usage

# Quick setup (recommended for most users)
python3 -m SuperClaude install

# Interactive selection (choose components)
python3 -m SuperClaude install --interactive

# Minimal install (just core framework)
python3 -m SuperClaude install --minimal

# Developer setup (everything included)
python3 -m SuperClaude install --profile developer

# See all available options
python3 -m SuperClaude install --help

Simple bash Command Usage

# Quick setup (recommended for most users)
SuperClaude install

# Interactive selection (choose components)
SuperClaude install --interactive

# Minimal install (just core framework)
SuperClaude install --minimal

# Developer setup (everything included)
SuperClaude install --profile developer

# See all available options
SuperClaude install --help

That's it! ๐ŸŽ‰ The installer handles everything: framework files, MCP servers, and Claude Code configuration.

How It Works ๐Ÿ”„

SuperClaude tries to enhance Claude Code through:

  1. Framework Files - Documentation installed to ~/.claude/ that guides how Claude responds
  2. Slash Commands - 16 specialized commands for different dev tasks
  3. MCP Servers - External services that add extra capabilities (when they work!)
  4. Smart Routing - Attempts to pick the right tools and experts based on what you're doing

Most of the time it plays nicely with Claude Code's existing stuff. ๐Ÿค

What's Coming in v4 ๐Ÿ”ฎ

We're hoping to work on these things for the next version:

  • Hooks System - Event-driven stuff (removed from v3, trying to redesign it properly)
  • MCP Suite - More external tool integrations
  • Better Performance - Trying to make things faster and less buggy
  • More Personas - Maybe a few more domain specialists
  • Cross-CLI Support - Might work with other AI coding assistants

(No promises on timeline though - we're still figuring v3 out! ๐Ÿ˜…)

Configuration โš™๏ธ

After installation, you can customize SuperClaude by editing:

  • ~/.claude/settings.json - Main configuration
  • ~/.claude/*.md - Framework behavior files

Most users probably won't need to change anything - it usually works okay out of the box. ๐ŸŽ›๏ธ

Documentation ๐Ÿ“–

Want to learn more? Check out our guides:

These guides have more details than this README and are kept up to date.

Contributing ๐Ÿค

We welcome contributions! Areas where we could use help:

  • ๐Ÿ› Bug Reports - Let us know what's broken
  • ๐Ÿ“ Documentation - Help us explain things better
  • ๐Ÿงช Testing - More test coverage for different setups
  • ๐Ÿ’ก Ideas - Suggestions for new features or improvements

The codebase is pretty straightforward Python + documentation files.

Project Structure ๐Ÿ“

SuperClaude/
โ”œโ”€โ”€ setup.py               # pypi setup file
โ”œโ”€โ”€ SuperClaude/           # Framework files  
โ”‚   โ”œโ”€โ”€ Core/              # Behavior documentation (COMMANDS.md, FLAGS.md, etc.)
โ”‚   โ”œโ”€โ”€ Commands/          # 16 slash command definitions
โ”‚   โ””โ”€โ”€ Settings/          # Configuration files
โ”œโ”€โ”€ setup/                 # Installation system
โ””โ”€โ”€ profiles/              # Installation profiles (quick, minimal, developer)

Architecture Notes ๐Ÿ—๏ธ

The v3 architecture focuses on:

  • Simplicity - Removed complexity that wasn't adding value
  • Reliability - Better installation and fewer breaking changes
  • Modularity - Pick only the components you want
  • Performance - Faster operations with smarter caching

We learned a lot from v2 and tried to address the main pain points.

FAQ ๐Ÿ™‹

Q: Why was the hooks system removed?
A: It was getting complex and buggy. We're redesigning it properly for v4.

Q: Does this work with other AI assistants?
A: Currently Claude Code only, but v4 will have broader compatibility.

Q: Is this stable enough for daily use?
A: The basic stuff works pretty well, but definitely expect some rough edges since it's a fresh release. Probably fine for experimenting! ๐Ÿงช

SuperClaude Contributors

Contributors

License

MIT - See LICENSE file for details

Star History

Star History Chart ---

Built by developers who got tired of generic responses. Hope you find it useful! ๐Ÿ™‚


About

A configuration framework that enhances Claude Code with specialized commands, cognitive personas, and development methodologies.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages