mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-17 17:56:46 +00:00

🔖 Bump version to 4.0.8

- Update version across all project files
- Update CHANGELOG.md with release notes
- Prepare for PyPI release

2025-08-23 15:05:12 +02:00

12 KiB

Raw Blame History

SuperClaude Commands Guide

SuperClaude provides 21 commands for Claude Code: /sc:* commands for workflows and @agent-* for specialists.

Command Types

Type	Where Used	Format	Example
Slash Commands	Claude Code	`/sc:[command]`	`/sc:implement "feature"`
Agents	Claude Code	`@agent-[name]`	`@agent-security "review"`
Installation	Terminal	`SuperClaude [command]`	`SuperClaude install`

Quick Test

# Terminal: Verify installation
python3 -m SuperClaude --version
# Claude Code CLI verification: claude --version

# Claude Code: Test commands
/sc:brainstorm "test project"    # Should ask discovery questions
/sc:analyze README.md           # Should provide analysis

Workflow: /sc:brainstorm "idea" → /sc:implement "feature" → /sc:test

🎯 Understanding SuperClaude Commands

How SuperClaude Works

SuperClaude provides behavioral context files that Claude Code reads to adopt specialized behaviors. When you type /sc:implement, Claude Code reads the implement.md context file and follows its behavioral instructions.

SuperClaude commands are NOT executed by software - they are context triggers that modify Claude Code's behavior through reading specialized instruction files from the framework.

Command Types:

Slash Commands (/sc:*): Trigger workflow patterns and behavioral modes
Agent Invocations (@agent-*): Manually activate specific domain specialists
Flags (--think, --safe-mode): Modify command behavior and depth

The Context Mechanism:

User Input: You type /sc:implement "auth system"
Context Loading: Claude Code reads ~/.claude/SuperClaude/Commands/implement.md
Behavior Adoption: Claude applies domain expertise, tool selection, and validation patterns
Enhanced Output: Structured implementation with security considerations and best practices

Key Point: This creates sophisticated development workflows through context management rather than traditional software execution.

Installation vs Usage Commands

🖥️ Terminal Commands (Actual CLI software):

SuperClaude install - Installs the framework components
SuperClaude update - Updates existing installation
SuperClaude uninstall - Removes framework installation
python3 -m SuperClaude --version - Check installation status

💬 Claude Code Commands (Context triggers):

/sc:brainstorm - Activates requirements discovery context
/sc:implement - Activates feature development context
@agent-security - Activates security specialist context
All commands work inside Claude Code chat interface only

Quick Start: Try /sc:brainstorm "your project idea" → /sc:implement "feature name" → /sc:test to experience the core workflow.

🧪 Testing Your Setup

🖥️ Terminal Verification (Run in Terminal/CMD)

# Verify SuperClaude is working (primary method)
python3 -m SuperClaude --version
# Example output: SuperClaude 4.0.8

# Claude Code CLI version check
claude --version

# Check installed components
python3 -m SuperClaude install --list-components | grep mcp
# Example output: Shows installed MCP components

💬 Claude Code Testing (Type in Claude Code Chat)

# Test basic /sc: command
/sc:brainstorm "test project"
# Example behavior: Interactive requirements discovery starts

# Test command help
/sc:help
# Example behavior: List of available commands

If tests fail: Check Installation Guide or Troubleshooting

📝 Command Quick Reference

Command Type	Where to Run	Format	Purpose	Example
🖥️ Installation	Terminal/CMD	`SuperClaude [command]`	Setup and maintenance	`SuperClaude install`
🔧 Configuration	Terminal/CMD	`python3 -m SuperClaude [command]`	Advanced configuration	`python3 -m SuperClaude --version`
💬 Slash Commands	Claude Code	`/sc:[command]`	Workflow automation	`/sc:implement "feature"`
🤖 Agent Invocation	Claude Code	`@agent-[name]`	Manual specialist activation	`@agent-security "review"`
⚡ Enhanced Flags	Claude Code	`/sc:[command] --flags`	Behavior modification	`/sc:analyze --think-hard`

Remember: All /sc: commands and @agent- invocations work inside Claude Code chat, not your terminal. They trigger Claude Code to read specific context files from the SuperClaude framework.

Essential Commands - Start here (8 core commands)
Common Workflows - Command combinations that work
Full Command Reference - All 21 commands organized by category
Troubleshooting - Common issues and solutions
Command Index - Find commands by category

Essential Commands

Core workflow commands for immediate productivity:

`/sc:brainstorm` - Project Discovery

Purpose: Interactive requirements discovery and project planning
Syntax: /sc:brainstorm "your idea" [--strategy systematic|creative]

Use Cases:

New project planning: /sc:brainstorm "e-commerce platform"
Feature exploration: /sc:brainstorm "user authentication system"
Problem solving: /sc:brainstorm "slow database queries"

`/sc:implement` - Feature Development

Purpose: Full-stack feature implementation with intelligent specialist routing
Syntax: /sc:implement "feature description" [--type frontend|backend|fullstack] [--focus security|performance]

Use Cases:

Authentication: /sc:implement "JWT login system"
UI components: /sc:implement "responsive dashboard"
APIs: /sc:implement "REST user endpoints"
Database: /sc:implement "user schema with relationships"

`/sc:analyze` - Code Assessment

Purpose: Comprehensive code analysis across quality, security, and performance
Syntax: /sc:analyze [path] [--focus quality|security|performance|architecture]

Use Cases:

Project health: /sc:analyze .
Security audit: /sc:analyze --focus security
Performance review: /sc:analyze --focus performance

`/sc:troubleshoot` - Problem Diagnosis

Purpose: Systematic issue diagnosis with root cause analysis
Syntax: /sc:troubleshoot "issue description" [--type build|runtime|performance]

Use Cases:

Runtime errors: /sc:troubleshoot "500 error on login"
Build failures: /sc:troubleshoot --type build
Performance problems: /sc:troubleshoot "slow page load"

`/sc:test` - Quality Assurance

Purpose: Comprehensive testing with coverage analysis
Syntax: /sc:test [--type unit|integration|e2e] [--coverage] [--fix]

Use Cases:

Full test suite: /sc:test --coverage
Unit testing: /sc:test --type unit --watch
E2E validation: /sc:test --type e2e

`/sc:improve` - Code Enhancement

Purpose: Apply systematic code improvements and optimizations
Syntax: /sc:improve [path] [--type performance|quality|security] [--preview]

Use Cases:

General improvements: /sc:improve src/
Performance optimization: /sc:improve --type performance
Security hardening: /sc:improve --type security

`/sc:document` - Documentation Generation

Purpose: Generate comprehensive documentation for code and APIs
Syntax: /sc:document [path] [--type api|user-guide|technical] [--format markdown|html]

Use Cases:

API docs: /sc:document --type api
User guides: /sc:document --type user-guide
Technical docs: /sc:document --type technical

`/sc:workflow` - Implementation Planning

Purpose: Generate structured implementation plans from requirements
Syntax: /sc:workflow "feature description" [--strategy agile|waterfall] [--format markdown]

Use Cases:

Feature planning: /sc:workflow "user authentication"
Sprint planning: /sc:workflow --strategy agile
Architecture planning: /sc:workflow "microservices migration"

Common Workflows

Proven command combinations:

New Project Setup

/sc:brainstorm "project concept"      # Define requirements
/sc:design "system architecture"      # Create technical design  
/sc:workflow "implementation plan"    # Generate development roadmap

Feature Development

/sc:implement "feature name"          # Build the feature
/sc:test --coverage                   # Validate with tests
/sc:document --type api               # Generate documentation

Code Quality Improvement

/sc:analyze --focus quality           # Assess current state
/sc:improve --preview                 # Preview improvements
/sc:test --coverage                   # Validate changes

Bug Investigation

/sc:troubleshoot "issue description"  # Diagnose the problem
/sc:analyze --focus problem-area      # Deep analysis
/sc:improve --fix --safe-mode         # Apply targeted fixes

Full Command Reference

Development Commands

Command	Purpose	Best For
workflow	Implementation planning	Project roadmaps, sprint planning
implement	Feature development	Full-stack features, API development
build	Project compilation	CI/CD, production builds
design	System architecture	API specs, database schemas

Analysis Commands

Command	Purpose	Best For
analyze	Code assessment	Quality audits, security reviews
troubleshoot	Problem diagnosis	Bug investigation, performance issues
explain	Code explanation	Learning, code reviews

Quality Commands

Command	Purpose	Best For
improve	Code enhancement	Performance optimization, refactoring
cleanup	Technical debt	Dead code removal, organization
test	Quality assurance	Test automation, coverage analysis
document	Documentation	API docs, user guides

Project Management

Command	Purpose	Best For
estimate	Project estimation	Timeline planning, resource allocation
task	Task management	Complex workflows, task tracking
spawn	Meta-orchestration	Large-scale projects, parallel execution

Utility Commands

Command	Purpose	Best For
git	Version control	Commit management, branch strategies
index	Command discovery	Exploring capabilities, finding commands

Session Commands

Command	Purpose	Best For
load	Context loading	Session initialization, project onboarding
save	Session persistence	Checkpointing, context preservation
reflect	Task validation	Progress assessment, completion validation
select-tool	Tool optimization	Performance optimization, tool selection

Command Index

By Function:

Planning: brainstorm, design, workflow, estimate
Development: implement, build, git
Analysis: analyze, troubleshoot, explain
Quality: improve, cleanup, test, document
Management: task, spawn, load, save, reflect
Utility: index, select-tool

By Complexity:

Beginner: brainstorm, implement, analyze, test
Intermediate: workflow, design, improve, document
Advanced: spawn, task, select-tool, reflect

Troubleshooting

Command Issues:

Command not found: Verify installation: python3 -m SuperClaude --version
No response: Restart Claude Code session
Processing delays: Use --no-mcp to test without MCP servers

Quick Fixes:

Reset session: /sc:load to reinitialize
Check status: SuperClaude install --list-components
Get help: Troubleshooting Guide

Next Steps

Flags Guide - Control command behavior
Agents Guide - Specialist activation
Examples Cookbook - Real usage patterns

12 KiB Raw Blame History

SuperClaude Commands Guide

Command Types

Quick Test

🎯 Understanding SuperClaude Commands

How SuperClaude Works

Command Types:

The Context Mechanism:

Installation vs Usage Commands

🧪 Testing Your Setup

🖥️ Terminal Verification (Run in Terminal/CMD)

💬 Claude Code Testing (Type in Claude Code Chat)

📝 Command Quick Reference

Table of Contents

Essential Commands

/sc:brainstorm - Project Discovery

/sc:implement - Feature Development

/sc:analyze - Code Assessment

/sc:troubleshoot - Problem Diagnosis

/sc:test - Quality Assurance

/sc:improve - Code Enhancement

/sc:document - Documentation Generation

/sc:workflow - Implementation Planning

Common Workflows

New Project Setup

Feature Development

Code Quality Improvement

Bug Investigation

Full Command Reference

Development Commands

Analysis Commands

Quality Commands

Project Management

Utility Commands

Session Commands

Command Index

Troubleshooting

Next Steps

12 KiB

Raw Blame History

`/sc:brainstorm` - Project Discovery

`/sc:implement` - Feature Development

`/sc:analyze` - Code Assessment

`/sc:troubleshoot` - Problem Diagnosis

`/sc:test` - Quality Assurance

`/sc:improve` - Code Enhancement

`/sc:document` - Documentation Generation

`/sc:workflow` - Implementation Planning