Mithun Gowda B 3ba17b6ca2
Bump version (#373)
* Fix: Install only selected MCP servers and ensure valid empty backups

This commit addresses two separate issues:

1.  **MCP Installation:** The `install` command was installing all MCP servers instead of only the ones selected by the user. The `_install` method in `setup/components/mcp.py` was iterating through all available servers, not the user's selection. This has been fixed to respect the `selected_mcp_servers` configuration. A new test has been added to verify this fix.

2.  **Backup Creation:** The `create_backup` method in `setup/core/installer.py` created an invalid `.tar.gz` file when the backup source was empty. This has been fixed to ensure that a valid, empty tar archive is always created. A test was added for this as well.
Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>

* Fix: Correct installer validation for MCP and MCP Docs components

This commit fixes a validation issue in the installer where it would incorrectly fail after a partial installation of MCP servers.

The `MCPComponent` validation logic was checking for all "required" servers, regardless of whether they were selected by the user. This has been corrected to only validate the servers that were actually installed, by checking against the list of installed servers stored in the metadata. The metadata storage has also been fixed to only record the installed servers.

The `MCPDocsComponent` was failing validation because it was not being registered in the metadata if no documentation files were installed. This has been fixed by ensuring the post-installation hook runs even when no files are copied.

New tests have been added for both components to verify the corrected logic.

Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>

* Fix: Allow re-installation of components and correct validation logic

This commit fixes a bug that prevented new MCP servers from being installed on subsequent runs of the installer. It also fixes the validation logic that was causing failures after a partial installation.

The key changes are:
1.  A new `is_reinstallable` method has been added to the base `Component` class. This allows certain components (like the `mcp` component) to be re-run even if they are already marked as installed.
2.  The installer logic has been updated to respect this new method.
3.  The `MCPComponent` now correctly stores only the installed servers in the metadata.
4.  The validation logic for `MCPComponent` and `MCPDocsComponent` has been corrected to prevent incorrect failures.

New tests have been added to verify all aspects of the new logic.

Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>

* feat: Display authors in UI header and update author info

This commit implements the user's request to display author names and emails in the UI header of the installer.

The key changes are:
1.  The `__email__` field in `SuperClaude/__init__.py` has been updated to include both authors' emails.
2.  The `display_header` function in `setup/utils/ui.py` has been modified to read the author and email information and display it.
3.  A new test has been added to `tests/test_ui.py` to verify the new UI output.

Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>

* feat: Version bump to 4.1.0 and various fixes

This commit prepares the project for the v4.1.0 release. It includes a version bump across all relevant files and incorporates several bug fixes and feature enhancements from recent tasks.

Key changes in this release:

- **Version Bump**: The project version has been updated from 4.0.9 to 4.1.0 in all configuration files, documentation, and source code.

- **Installer Fixes**:
  - Components can now be marked as `reinstallable`, allowing them to be re-run on subsequent installations. This fixes a bug where new MCP servers could not be added.
  - The validation logic for `mcp` and `mcp_docs` components has been corrected to avoid incorrect failures.
  - A bug in the backup creation process that created invalid empty archives has been fixed.

- **UI Enhancements**:
  - Author names and emails are now displayed in the installer UI header.

- **Metadata Updates**:
  - Mithun Gowda B has been added as an author.

- **New Tests**:
  - Comprehensive tests have been added for the installer logic, MCP components, and UI changes to ensure correctness and prevent regressions.

Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>

* fix: Resolve dependencies for partial installs and other fixes

This commit addresses several issues, the main one being a dependency resolution failure during partial installations.

Key changes:
- **Dependency Resolution**: The installer now correctly resolves the full dependency tree when a user requests to install a subset of components. This fixes the "Unknown component: core" error.
- **Component Re-installation**: A new `is_reinstallable` flag allows components like `mcp` to be re-run on subsequent installs, enabling the addition of new servers.
- **Validation Logic**: The validation for `mcp` and `mcp_docs` has been corrected to avoid spurious failures.
- **UI and Metadata**: Author information has been added to the UI header and source files.
- **Version Bump**: The project version has been updated to 4.1.0.
- **Tests**: New tests have been added to cover all the above changes.

Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>

* fix: Installer fixes and version bump to 4.1.0

This commit includes a collection of fixes for the installer logic, UI enhancements, and a version bump to 4.1.0.

Key changes:
- **Dependency Resolution**: The installer now correctly resolves the full dependency tree for partial installations, fixing the "Unknown component: core" error.
- **Component Re-installation**: A new `is_reinstallable` flag allows components like `mcp` to be re-run to add new servers.
- **MCP Installation**: The non-interactive installation of the `mcp` component now correctly prompts the user to select servers.
- **Validation Logic**: The post-installation validation logic has been corrected to only validate components from the current session and to use the correct list of installed servers.
- **UI & Metadata**: Author information has been added to the UI and source files.
- **Version Bump**: The project version has been updated from 4.0.9 to 4.1.0 across all files.
- **Tests**: New tests have been added to cover all the bug fixes.

Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>

* feat: Add --authors flag and multiple installer fixes

This commit introduces the `--authors` flag to display author information and includes a collection of fixes for the installer logic.

Key changes:
- **New Feature**: Added an `--authors` flag that displays the names, emails, and GitHub usernames of the project authors.
- **Dependency Resolution**: Fixed a critical bug where partial installations would fail due to unresolved dependencies.
- **Component Re-installation**: Added a mechanism to allow components to be "reinstallable", fixing an issue that prevented adding new MCP servers on subsequent runs.
- **MCP Installation**: The non-interactive installation of the `mcp` component now correctly prompts for server selection.
- **Validation Logic**: Corrected the post-installation validation to prevent spurious errors.
- **Version Bump**: The project version has been updated to 4.1.0.
- **Metadata**: Author and GitHub information has been added to the source files.
- **UI**: The installer header now displays author information.
- **Tests**: Added new tests for all new features and bug fixes.

Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>

* Add Docker support and framework enhancements

- Add serena-docker.json MCP configuration
- Update MCP configs and installer components
- Enhance CLI commands with new functionality
- Add symbols utility for framework operations
- Improve UI and logging components

🤖 Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>

* Bump version from 4.1.1 to 4.1.2

- Update version across all package files
- Update documentation and README files
- Update Python module version strings
- Update feature configuration files

🤖 Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
Co-Authored-By: Mithun Gowda B <mithungowda.b7411@gmail.com>

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: Jules <jules-ai-assistant@users.noreply.github.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
Co-authored-by: Prashant R <rprashanth681@gmail.com>
2025-09-19 19:09:27 +05:30

10 KiB

🚀 SuperClaude Quick Start Guide

Context Engineering Framework for Claude Code

Framework Version Quick Start

💡 Key Insight: SuperClaude doesn't replace Claude Code - it configures and enhances it through behavioral context injection

How It WorksInstant StartComponentsWorkflowsWhen to Use


📊 Framework Capabilities

Commands AI Agents Behavioral Modes MCP Servers
21 14 6 6
/sc: triggers Domain specialists Context adaptation Tool integration

🎯 How It Works

Framework Architecture Flow

┌─────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│  User Input     │────>│   Claude Code    │────>│  Context Files  │
│  /sc:command    │     │  Reads Context   │     │  (.md behaviors)│
└─────────────────┘     └──────────────────┘     └─────────────────┘
                               │                          │
                               ▼                          ▼
┌─────────────────┐      ┌──────────────────┐     ┌─────────────────┐
│   Enhanced      │<─────│    Behavioral    │<────│   MCP Servers   │
│   Response      │      │    Activation    │     │ (if configured) │
└─────────────────┘      └──────────────────┘     └─────────────────┘

The Magic: When you type /sc:brainstorm, Claude reads behavioral instructions from installed .md files and responds with enhanced capabilities


Instant Start

5-Minute Journey from Installation to First Command

📦 Step 1: Install (Terminal) 💬 Step 2: Use (Claude Code)
# Quick install with pipx
pipx install SuperClaude && SuperClaude install

# Or traditional pip
pip install SuperClaude && SuperClaude install

# Or via npm
npm install -g @bifrost_inc/superclaude && superclaude install
# Interactive discovery
/sc:brainstorm "web app for task management"

# Analyze existing code
/sc:analyze src/

# Generate implementation
/sc:implement "user authentication"

# Activate specialist
@agent-security "review auth flow"
🎥 What Happens Behind the Scenes
  1. Context Loading: Claude Code imports behavioral .md files via CLAUDE.md
  2. Pattern Recognition: Recognizes /sc: and @agent- trigger patterns
  3. Behavioral Activation: Applies corresponding instructions from context files
  4. MCP Integration: Uses configured external tools when available
  5. Response Enhancement: Follows framework patterns for comprehensive responses

🔧 Core Components

Four Pillars of SuperClaude

📝 Commands

21

Slash Commands

/sc:brainstorm
/sc:implement
/sc:analyze
/sc:workflow

Workflow automation

🤖 Agents

14

AI Specialists

@agent-architect
@agent-security
@agent-frontend
@agent-backend

Domain expertise

🎯 Modes

6

Behavioral Modes

Brainstorming
Introspection
Orchestration
Task Management

Context adaptation

🔌 MCP

6

Server Integration

Context7 (docs)
Sequential (analysis)
Magic (UI)
Playwright (testing)

Enhanced tools


📚 Workflow Patterns

Complete Development Lifecycle

🌟 First Project Session

Step Command What Happens
1. Discovery /sc:brainstorm "e-commerce app" Interactive requirements exploration
2. Load Context /sc:load src/ Import existing project structure
3. Analysis /sc:analyze --focus architecture Deep architectural review
4. Planning /sc:workflow "payment integration" Generate implementation roadmap
5. Implementation /sc:implement "Stripe checkout" Build with best practices
6. Validation /sc:test --coverage Comprehensive testing
7. Save Session /sc:save "payment-complete" Persist for next session

🎨 Domain-Specific Workflows

Domain Trigger Specialist Activation MCP Server
Frontend UI component request @agent-frontend Magic
Backend API endpoint creation @agent-backend Sequential
Security Auth implementation @agent-security Context7
Testing E2E test scenarios @agent-qa Playwright
DevOps Deployment setup @agent-devops Morphllm

🎯 When to Use

SuperClaude vs Standard Claude Code

Use SuperClaude 💭 Use Standard Claude

Perfect for:

  • 🏗️ Building complete software projects
  • 📊 Systematic workflows with quality gates
  • 🔄 Complex, multi-component systems
  • 💾 Long-term projects needing persistence
  • 👥 Team collaboration with standards
  • 🎯 Domain-specific expertise needs

Examples:

  • "Build a full-stack application"
  • "Implement secure authentication"
  • "Refactor legacy codebase"
  • "Create comprehensive test suite"

Better for:

  • 💡 Simple questions or explanations
  • One-off coding tasks
  • 📚 Learning programming concepts
  • 🧪 Quick prototypes or experiments
  • 🔍 Code snippet generation
  • General programming help

Examples:

  • "Explain how async/await works"
  • "Write a sorting function"
  • "Debug this error message"
  • "Convert this loop to functional"

🎓 Learning Path

Your 4-Week Journey to Mastery

Week Focus Skills Milestone
1
🌱
Core Commands /sc:brainstorm
/sc:analyze
/sc:implement
Complete first project
2
🌿
Behavioral Modes • Mode combinations
• Flag usage
• Context optimization
Optimize workflows
3
🌿
MCP Servers • Server configuration
• Tool integration
• Enhanced capabilities
Full tool utilization
4
🌲
Advanced Patterns • Custom workflows
• Session management
• Team patterns
Framework mastery

💡 Key Insights

Understanding SuperClaude's Value

🧠 Not Software

It's a Framework

SuperClaude is behavioral configuration, not standalone software. Everything runs through Claude Code.

🔄 Systematic

Not Ad-hoc

Transforms random requests into structured workflows with quality gates and validation.

🚀 Progressive

Not Complex

Start simple with basic commands. Complexity emerges naturally as needed.


📖 Next Steps

Continue Your Learning Journey

🌱 Beginner 🌿 Intermediate 🌲 Advanced

First Week:

Start with /sc:brainstorm

Growing Skills:

Explore mode combinations

Expert Usage:

Create custom workflows

Commands Examples


🎉 Ready to Transform Your Development Workflow?

Start now with /sc:brainstorm in Claude Code!

SuperClaude v4.1.2 - Context Engineering for Claude Code