### Setup development environment Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/architecture/MIGRATION_TO_CLEAN_ARCHITECTURE.md Commands to clone the repository, install with development dependencies, and run tests. ```bash # Clone repository git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git cd SuperClaude_Framework # Install in editable mode with dev dependencies pip install -e ".[dev]" # Run tests pytest tests/ -v # Check pytest plugin pytest --trace-config ``` -------------------------------- ### Project Index File Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide/commands.md This file serves as the project quick start guide. ```markdown PROJECT_INDEX.md # Project quick start (3K tokens) ``` -------------------------------- ### Example: Session 1 Start Authentication Task Source: https://github.com/superclaude-org/superclaude_framework/blob/master/src/superclaude/modes/MODE_Task_Management.md Demonstrates the initial steps of starting an authentication task, including setting up the plan, phase, and initial task, along with creating specific todos. ```shell list_memories() → Empty write_memory("plan_auth", "Implement JWT authentication system") write_memory("phase_1", "Analysis - security requirements review") write_memory("task_1.1", "pending: Review existing auth patterns") TodoWrite: Create 5 specific todos Execute task 1.1 → write_memory("task_1.1", "completed: Found 3 patterns") ``` -------------------------------- ### Install SuperClaude Components Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/developer-guide/testing-debugging.md Command to install framework components using the setup module. ```bash PYTHONPATH=/path/to/SuperClaude_Framework python3 -m setup install --components mcp --force ``` -------------------------------- ### Generate Brief User Guide Source: https://github.com/superclaude-org/superclaude_framework/blob/master/plugins/superclaude/commands/document.md Creates user-focused documentation with practical examples, focusing on implementation patterns and common use cases for a specific module. ```bash /sc:document payment-module --type guide --style brief # Creates user-focused documentation with practical examples # Focuses on implementation patterns and common use cases ``` -------------------------------- ### Dual Installation Commands Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/architecture/PHASE_3_COMPLETE.md Commands for core framework installation and optional skill installation. ```bash uv pip install -e . ``` ```bash superclaude install-skill pm-agent ``` -------------------------------- ### Initialize Installation Configuration Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/research/research_installer_improvements_20251017.md Constructs an installation configuration object with automatic validation. ```python config = InstallationConfig( components=["core", "mcp"], install_dir=Path("/Users/kazuki/.claude") ) # Automatic validation on construction ``` -------------------------------- ### Install and Initialize Pre-commit Hooks Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/research/research_python_directory_naming_automation_2025.md Install the pre-commit package and then install the defined hooks into the local repository. Run pre-commit hooks on all files for an initial check. ```bash # Install pre-commit uv pip install pre-commit # Install hooks pre-commit install # Run on all files (initial check) pre-commit run --all-files ``` -------------------------------- ### Install Virtual Display on Linux Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/mcp-server-guide.md Installs Xvfb, a virtual framebuffer, and starts a display server on a specified display number. ```bash sudo apt-get install xvfb ``` ```bash export DISPLAY=:99 ``` ```bash Xvfb :99 -screen 0 1024x768x24 & ``` -------------------------------- ### Execute Installation Process Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide/mcp-installation.md Standard workflow for checking, installing, and verifying MCP servers. ```bash superclaude mcp --list ``` ```bash superclaude mcp ``` ```bash superclaude mcp --servers tavily context7 ``` ```bash claude mcp list ``` -------------------------------- ### Recommendations Command Example Source: https://github.com/superclaude-org/superclaude_framework/blob/master/src/superclaude/commands/sc.md Example of requesting command recommendations. ```text /sc:recommend ``` -------------------------------- ### Install SuperClaude from Git Source: https://github.com/superclaude-org/superclaude_framework/blob/master/README.md Direct installation method by cloning the repository and executing the provided installation script. ```bash # Clone the repository git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git cd SuperClaude_Framework # Run the installation script ./install.sh ``` -------------------------------- ### Agile Feature Exploration Example Source: https://github.com/superclaude-org/superclaude_framework/blob/master/plugins/superclaude/commands/brainstorm.md Enables parallel exploration of real-time collaboration features using an agile strategy. This setup involves frontend, backend, and security personas, with Context7 and Magic MCP for framework and UI analysis. ```bash /sc:brainstorm "real-time collaboration features" --strategy agile --parallel # Parallel exploration paths with frontend, backend, and security personas # Context7 and Magic MCP for framework and UI pattern analysis ``` -------------------------------- ### Install SuperClaude Framework Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/README.md Use pipx or pip to install the framework and initialize the configuration. ```bash # Recommended for Linux/macOS pipx install SuperClaude && SuperClaude install # Traditional method pip install SuperClaude && SuperClaude install # Then try: /sc:brainstorm "web app idea" in Claude Code ``` -------------------------------- ### Agent Command Examples Source: https://github.com/superclaude-org/superclaude_framework/blob/master/src/superclaude/commands/sc.md Examples of launching different types of AI agents. ```text /sc:agent deep-research /sc:agent self-review /sc:agent repo-index ``` -------------------------------- ### Install MCP Servers using CLI Source: https://github.com/superclaude-org/superclaude_framework/blob/master/README.md Use the superclaude CLI to list, install, or interactively set up MCP servers. Ensure you have the superclaude CLI installed. ```bash # List available MCP servers superclaude mcp --list ``` ```bash # Install specific servers superclaude mcp --servers tavily context7 ``` ```bash # Interactive installation superclaude mcp ``` -------------------------------- ### Install with User Permissions Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/getting-started/windows-installation.md Use the --user flag if you encounter permission errors during installation. ```powershell pip install --user superclaude ``` -------------------------------- ### Session Start Protocol Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide/commands.md Instructions for starting a new session and understanding project context. ```APIDOC ## Notes for Future Sessions ### Description Instructions for starting a new session and understanding project context. ### Session Start Protocol When starting a new session: 1. **For quick start** → read `PROJECT_INDEX.md` (3K tokens) 2. **For command architecture understanding** → read this file (`SC_COMMANDS_REFERENCE.md`) 3. **For specific command details** → `src/superclaude/commands/{name}.md` 4. **For Python implementation** → `src/superclaude/pm_agent/` and `src/superclaude/execution/` 5. **For pytest fixtures** → `src/superclaude/pytest_plugin.py` 6. **For best practices** → `KNOWLEDGE.md` 7. **For current tasks** → `TASK.md` 8. **For architectural decisions** → `PLANNING.md` ``` -------------------------------- ### Analyze Installed Components Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/troubleshooting.md Inspect the installation directory and verify component imports. ```bash ls -la ~/.claude/ # Check installed files grep -r "@" ~/.claude/CLAUDE.md # Verify imports ``` -------------------------------- ### Install SuperClaude for Development Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/getting-started/installation.md Installs SuperClaude from source for contributors and developers. Includes cloning the repository, installing uv, and setting up in development mode. ```bash # Clone repository git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git cd SuperClaude_Framework # Install uv if not present curl -LsSf https://astral.sh/uv/install.sh | sh # Install in development mode uv pip install -e ".[dev]" # Test installation SuperClaude install --dry-run ``` -------------------------------- ### Install SuperClaude with Options Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/getting-started/installation.md Use these commands to customize your SuperClaude installation. Options include guided setup, specific component installation, previewing changes, forcing installation, and listing available components. ```bash SuperClaude install ``` ```bash SuperClaude install --components core mcp modes ``` ```bash SuperClaude install --dry-run ``` ```bash SuperClaude install --force --yes ``` ```bash SuperClaude install --list-components ``` -------------------------------- ### Initialize New Project Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide/commands.md Commands to set up a new project using Serena or index-repo. ```bash # Option A: Via Serena (recommended) 1. serena activate_project . # Activate project 2. serena onboarding # Create memories (project_overview, commands, etc.) # Option B: Via index-repo 1. /sc:index-repo # Create PROJECT_INDEX.md # Can use both — they complement each other ``` -------------------------------- ### Troubleshoot Node.js Setup Problems Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/basic-examples.md Fix issues where a Node.js application fails to start after 'npm install' using the troubleshoot command. This covers environment analysis and dependency troubleshooting. ```bash /sc:troubleshoot "Node.js application not starting after npm install" ``` -------------------------------- ### Execute multi-language command examples Source: https://github.com/superclaude-org/superclaude_framework/blob/master/plugins/superclaude/commands/recommend.md Examples of using the command with Turkish, English, and mixed-language inputs. ```bash # Turkish examples /sc:recommend "makine öğrenmesi algoritması başlat" /sc:recommend "sitem yavaş açılıyor, ne yapayım?" /sc:recommend "yeni bir özellik eklemeliyim" /sc:recommend "hata alıyorum, çözüm bul" # English examples /sc:recommend "I want to build ML algorithm" /sc:recommend "my website is slow, help me optimize" /sc:recommend "I need to add a new feature" /sc:recommend "getting errors, need debugging" # Mixed language /sc:recommend "makine learning projesi yapmak istiyorum" ``` -------------------------------- ### Install SuperClaude Commands Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/commands-list.md Commands for installing, listing, and updating SuperClaude. Use 'superclaude install' to install all commands, '--list' to see installed commands, and 'superclaude update' to get the latest version. ```bash # Install all 30 commands superclaude install # List installed commands superclaude install --list # Update to latest superclaude update ``` -------------------------------- ### Get SuperClaude Version Source: https://github.com/superclaude-org/superclaude_framework/blob/master/PROJECT_INDEX.md Display the installed version of the SuperClaude CLI tool. ```bash superclaude --version ``` -------------------------------- ### Comprehensive E-commerce Project Recommendation Example Source: https://github.com/superclaude-org/superclaude_framework/blob/master/plugins/superclaude/commands/recommend.md Demonstrates a full SuperClaude command execution for an e-commerce site, including detailed analysis, recommendations, smart flags, alternative technologies, time/budget estimates, and community data. This example showcases the power of combining multiple flags for in-depth project guidance. ```bash /sc:recommend "I'm building an e-commerce site" --estimate --alternatives --community 🎯 COMPREHENSIVE ANALYSIS ========================== 📊 Project Analysis: E-commerce website development 🌍 Language: Turkish detected 📁 Project Context: New project (no existing project) 🎭 Persona: --persona-architect + --persona-frontend + --persona-security 🔍 Category: Web development + E-commerce + Security-focused ✅ BEST RECOMMENDATIONS ================= 1. 🏗️ PLANNING AND DESIGN /sc:design --api --ddd --seq --ultrathink --persona-architect "E-commerce domain architecture and system design" 2. 🎨 FRONTEND DEVELOPMENT /sc:build --feature --magic --nextjs --persona-frontend "Modern, SEO-friendly e-commerce frontend" 3. 🔒 SECURITY AND BACKEND /sc:build --feature --tdd --persona-security "Secure payment system and user management" 🔧 SMART FLAG RECOMMENDATIONS ====================== 📚 Learning mode: --tutorial --examples (if you're just starting) 🚀 Quick start: --quick-start --template (e-commerce template) 🔒 Security-focused: --security --owasp --strict (for payment transactions) ⚡ Performance: --optimize --monitoring --cdn (for high traffic) 🔧 ALTERNATIVE TECHNOLOGIES ========================== ⭐ BEST: Next.js + Stripe + PostgreSQL ✅ Advantage: Modern stack, great SEO, scalable 👥 Community: 42% prefer this 🥈 SECOND: Vue.js + Shopify API + Headless CMS ✅ Advantage: Faster development, good DX 👥 Community: 18% prefer this 🥉 THIRD: React + Custom Backend + MongoDB ✅ Advantage: Maximum flexibility, full control 👥 Community: 15% prefer this ⏱️ TIME AND BUDGET ESTIMATE ======================== 📅 Project Duration: 6-12 weeks - Planning & Design: 1-2 weeks - Frontend Development: 2-4 weeks - Backend & Payment: 2-3 weeks - Testing & Security: 1-2 weeks - Deployment & Launch: 0.5-1 week 💰 Budget Estimate: - Solo Developer: 240-480 hours - Small Team (2-3 people): 480-1440 hours - Enterprise Team: 1440-2880 hours 👥 COMMUNITY DATA ================== 🏆 Most Successful Flow: /sc:analyze → /sc:design → /sc:build → /sc:test → /sc:deploy Success Rate: 87% (from 2,847 projects) 📈 Popular Features: - User authentication: 94% of projects have it - Payment integration: 89% of projects have it - Admin panel: 76% of projects have it - Inventory management: 68% of projects have it ⚠️ COMMON RISKS: - Payment security issues: 32% of projects experienced - Performance scaling: 28% of projects had issues - Tax calculation complexity: 45% of projects struggled 🚀 ADDITIONAL SUPER RECOMMENDATIONS =================== 💡 Premium Features (+2-4 weeks): - Multi-vendor marketplace - Advanced analytics dashboard - Mobile app (React Native) - AI-powered recommendations 🔒 Enterprise Security (+1-2 weeks): - SOC 2 compliance - Advanced fraud detection - PCI DSS certification - Security audit package 📱 Omnichannel Support (+2-3 weeks): - PWA capabilities - Mobile-first design - Social media integration - Progressive web app 🔄 STREAMING MODE CAN BE ACTIVATED =================================== To receive continuous recommendations throughout the project: /sc:recommend --stream "track my e-commerce project" You'll receive automatic recommendations at each stage! 🚀 ``` -------------------------------- ### Initialize Development Environment Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/developer-guide/contributing-code.md Commands to clone the repository and install components for development. ```bash # Fork SuperClaude_Framework on GitHub first git clone https://github.com/YOUR_USERNAME/SuperClaude_Framework.git cd SuperClaude_Framework # Test installation system PYTHONPATH=/path/to/SuperClaude_Framework python3 -m setup --help # Install to development location PYTHONPATH=/path/to/SuperClaude_Framework python3 -m setup install --components core ``` -------------------------------- ### Install and Run Pre-commit Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/research/research_python_directory_naming_automation_2025.md Commands to set up the pre-commit environment and execute hooks manually. ```bash # Install pre-commit pip install pre-commit # Install hooks to .git/hooks/ pre-commit install # Run manually on all files pre-commit run --all-files ``` -------------------------------- ### Pattern-Based Code Editing Examples Source: https://github.com/superclaude-org/superclaude_framework/blob/master/src/superclaude/mcp/MCP_Morphllm.md These examples demonstrate how to use Morphllm for various pattern-based code editing tasks. They cover updating code structure, enforcing style guides, and performing bulk text replacements. ```plaintext "update all React class components to hooks" → Morphllm (pattern transformation) ``` ```plaintext "enforce ESLint rules across project" → Morphllm (style guide application) ``` ```plaintext "replace all console.log with logger calls" → Morphllm (bulk text replacement) ``` -------------------------------- ### Setup AIRIS MCP Gateway Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide/mcp-servers.md Commands to clone, start, and register the AIRIS MCP Gateway for unified server management. ```bash git clone https://github.com/agiletec-inc/airis-mcp-gateway.git cd airis-mcp-gateway docker compose up -d # 2. Register with Claude Code claude mcp add --scope user --transport sse airis-mcp-gateway http://localhost:9400/sse ``` -------------------------------- ### Install Serena using uvx Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/troubleshooting/serena-installation.md Install Serena MCP server using the `uvx` command, which is the recommended method for remote GitHub repositories. This command also displays help information for Serena. ```bash uvx --from git+https://github.com/oraios/serena serena --help ``` -------------------------------- ### Setup pytest Environment Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/memory/next_actions.md Commands to install necessary testing dependencies in either a Docker container or a local virtual environment. ```bash # Option 1: Docker環境でセットアップ (推奨) docker compose exec workspace sh pip install pytest pytest-cov scipy # Option 2: 仮想環境でセットアップ python -m venv .venv source .venv/bin/activate pip install pytest pytest-cov scipy ``` -------------------------------- ### Manual Exception Handling Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/research/research_installer_improvements_20251017.md A basic example of catching a generic `Exception` during component installation. It logs the error and marks the component as failed, returning `False`. ```python except Exception as e: self.logger.error(f"Error installing {component_name}: {e}") self.failed_components.add(component_name) return False ``` -------------------------------- ### Remove Legacy Setup System Source: https://github.com/superclaude-org/superclaude_framework/blob/master/DELETION_RATIONALE.md This commit message indicates the removal of the old installation system (setup/) to reduce token consumption and refactor the project. ```git commit eb37591 refactor: remove legacy setup/ system and dependent tests Remove old installation system (setup/) that caused heavy token consumption ``` -------------------------------- ### Full Workflow Example: New Project Development Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide-zh/modes.md Illustrates a complete new project development workflow, showing how different modes (Brainstorm, Task Management, Orchestration) are automatically activated across stages. ```bash # Stage 1: Discovery (Brainstorm mode auto-activated) "I want to build a productivity app" → 🤔 Socratic questioning about users, features, platform choices → 📝 Structured requirements brief # Stage 2: Planning (Task Management mode auto-activated) /sc:implement "core productivity features" → 📋 Multi-stage breakdown with dependencies → 🎯 Stage coordination with quality gating # Stage 3: Implementation (Orchestration mode coordinates tools) /sc:implement "frontend and backend systems" → 🎯 Magic (UI) + Context7 (Patterns) + Sequential (Architecture) → ⚡ Parallel execution optimization ``` -------------------------------- ### Register Serena with Claude CLI Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/troubleshooting/serena-installation.md Register the Serena MCP server with the Claude CLI after installation. This command ensures Serena is recognized and can be started with the specified context. ```bash claude mcp add serena -- uvx --from git+https://github.com/oraios/serena serena start-mcp-server --context ide-assistant ``` -------------------------------- ### Combining Manual and Auto Approaches Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide/agents.md Shows how to start with an automated implementation and then explicitly add specialist agent reviews for specific tasks like security compliance and query optimization. ```bash # Start with command (auto-activation) /sc:implement "user profile system" # Then explicitly add specialist review @agent-security "review the profile system for OWASP compliance" @agent-performance-engineer "optimize database queries" ``` -------------------------------- ### Feature Implementation Examples Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/basic-examples.md Commands for implementing specific features like authentication systems. ```bash # Complete authentication system /sc:implement "user login with JWT tokens and password hashing" # Expected Implementation: # - Secure password hashing with bcrypt # - JWT token generation and validation # - Login/logout endpoints with proper error handling # - Frontend login form with validation # Activates: security-engineer + backend-architect + Context7 # Output: Production-ready authentication system # Variations for different auth needs: /sc:implement "OAuth integration with Google and GitHub" /sc:implement "password reset flow with email verification" /sc:implement "two-factor authentication with TOTP" ``` -------------------------------- ### Manual Serena MCP Server Configuration Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/troubleshooting/serena-installation.md Manually configure the Serena MCP server settings in `~/.claude.json` if automatic installation fails. This JSON object specifies the command and arguments for starting the Serena MCP server. ```json { "mcpServers": { "serena": { "command": "uvx", "args": [ "--from", "git+https://github.com/oraios/serena", "serena", "start-mcp-server", "--context", "ide-assistant" ] } } } ``` -------------------------------- ### Project Setup and Maintenance Commands Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide/commands.md Commands for initializing project indexing and updating project state. ```bash # Initial setup (once) serena activate_project . # Activate project serena onboarding # Create memories # and/or /sc:index-repo # Create PROJECT_INDEX.md # On structural changes /sc:index-repo mode=update # Update INDEX (if using) serena edit_memory ... # Update memories (if needed) ``` -------------------------------- ### Mode Combination Examples Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide-zh/modes.md Demonstrates how to combine different modes for complex workflows using command-line flags. Useful for multi-stage processes requiring both discovery and efficiency. ```bash # Discover → Plan → Implement /sc:brainstorm "microservices architecture" --task-manage # → Headstorm: Requirement Discovery # → Task Management: Multi-stage Coordination # Transparent and Efficient Analysis /sc:analyze legacy-system/ --introspect --uc # → Introspect: Transparent Reasoning # → Token Efficiency: Compressed Output ``` -------------------------------- ### Install UV using curl Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/troubleshooting/serena-installation.md If UV is not installed or `uvx` is unavailable, use this curl command to install UV. Ensure `uvx` is available after installation. ```bash curl -LsSf https://astral.sh/uv/install.sh | sh ``` -------------------------------- ### New Project Initialization Workflow Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide/session-management.md This sequence demonstrates initializing a new project by brainstorming requirements, saving initial decisions, defining a workflow, and saving architectural choices to persistent memory. ```bash # 1. Start fresh project /sc:brainstorm "e-commerce platform requirements" # 2. Save initial decisions to persistent memory /sc:save "project scope and requirements defined" # 3. Begin implementation planning /sc:workflow "user authentication system" # 4. Save architectural decisions permanently /sc:save "auth architecture: JWT + refresh tokens + rate limiting" ``` -------------------------------- ### Install SuperClaude from Source Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/getting-started/windows-installation.md Perform a development installation by cloning the repository and installing in editable mode. ```powershell git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git cd SuperClaude_Framework pip install -e ".[dev]" superclaude install ``` -------------------------------- ### Systematic Product Discovery Example Source: https://github.com/superclaude-org/superclaude_framework/blob/master/plugins/superclaude/commands/brainstorm.md Initiates systematic and deep exploration for an AI-powered project management tool. This example leverages architect, analyzer, and project-manager personas with the Sequential MCP for structured exploration. ```bash /sc:brainstorm "AI-powered project management tool" --strategy systematic --depth deep # Multi-persona analysis: architect (system design), analyzer (feasibility), project-manager (requirements) # Sequential MCP provides structured exploration framework ``` -------------------------------- ### Check Playwright Version After Installation Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/mcp-server-guide.md Verifies that Playwright is installed and accessible after installation or dependency fixes. ```bash npx playwright --version ``` -------------------------------- ### Install Playwright Browsers Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/mcp-server-guide.md Installs the necessary browsers for Playwright automation. Use 'install' for all or 'install-deps' for system dependencies. ```bash npx playwright install ``` ```bash npx playwright install-deps ``` -------------------------------- ### Diagnose Playwright Browser Installation Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/mcp-server-guide.md Checks if Playwright is installed globally and its version. This helps diagnose installation failures. ```bash npm list -g playwright ``` ```bash npx playwright --version ``` -------------------------------- ### Setup Database with ORM Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/basic-examples.md Integrate PostgreSQL with Prisma ORM and set up migrations using the implement command. This establishes the database schema, ORM, and migration system. ```bash /sc:implement "PostgreSQL integration with Prisma ORM and migrations" ``` -------------------------------- ### Verify SuperClaude Installation Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/getting-started/installation.md Check the installed SuperClaude version and list available components to confirm a successful installation. ```bash # Verify SuperClaude version python3 -m SuperClaude --version # Expected: SuperClaude 4.3.0 ``` ```bash # List installed components SuperClaude install --list-components # Expected: List of available components ``` -------------------------------- ### Install Superclaude Packages Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/architecture/PHASE_3_COMPLETE.md Comparison of the upstream installation method versus the new standard Python package installation. ```bash superclaude install # Installs to ~/.claude/superclaude/ ``` ```bash pip install superclaude # Standard Python package # Optional: Install Skills for auto-activation superclaude install-skill pm-agent ``` -------------------------------- ### Install SuperClaude with Pip Source: https://github.com/superclaude-org/superclaude_framework/blob/master/PROJECT_INDEX.md Install the SuperClaude package using pip. This is an alternative installation method if UV is not used. ```bash pip install superclaude ``` -------------------------------- ### API Service Implementation Example Source: https://github.com/superclaude-org/superclaude_framework/blob/master/plugins/superclaude/commands/implement.md Example of implementing a user authentication API. This command ensures security best practices are handled by the Security persona and server-side logic by the Backend persona. ```bash /sc:implement user authentication API --type api --safe --with-tests # Backend persona handles server-side logic and data processing # Security persona ensures authentication best practices ``` -------------------------------- ### Install SuperClaude with UV Source: https://github.com/superclaude-org/superclaude_framework/blob/master/PROJECT_INDEX.md Install the SuperClaude package using the UV package manager. This is the recommended installation method. ```bash uv pip install superclaude ``` -------------------------------- ### Framework-Specific Implementation Example Source: https://github.com/superclaude-org/superclaude_framework/blob/master/plugins/superclaude/commands/implement.md Example of implementing a dashboard widget with Vue.js. This command leverages Context7 MCP for Vue-specific patterns and official documentation, ensuring framework-appropriate implementation. ```bash /sc:implement dashboard widget --framework vue # Context7 MCP provides Vue-specific patterns and documentation # Framework-appropriate implementation with official best practices ``` -------------------------------- ### Install SuperClaude using npm Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/getting-started/installation.md Cross-platform installation method for Node.js developers. Installs SuperClaude globally via npm. ```bash # Global installation npm install -g @bifrost_inc/superclaude # Run the installer superclaude install ``` -------------------------------- ### Run Basic Diagnostic Commands Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/diagnostic-reference.md Verify installation version, count context files, check for empty files, and inspect directory structure. ```bash # Check if SuperClaude is installed python3 -m SuperClaude --version # Count context files find ~/.claude -name "*.md" -type f | wc -l # Expected: 40+ files # Check file sizes (context files should have content) find ~/.claude -name "*.md" -type f -size 0 # Expected: No output (no empty files) # Verify directory structure tree -L 2 ~/.claude/ # Or without tree command: ls -la ~/.claude/ ``` -------------------------------- ### Install SuperClaude using pipx Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/getting-started/installation.md Recommended method for isolated environments on Linux/macOS. Installs pipx, then SuperClaude, and runs the installer. ```bash # Install pipx if not present python3 -m pip install --user pipx python3 -m pipx ensurepath # Install SuperClaude pipx install SuperClaude # Run the installer SuperClaude install ``` -------------------------------- ### Full-Stack Feature Implementation Example Source: https://github.com/superclaude-org/superclaude_framework/blob/master/plugins/superclaude/commands/implement.md Example of implementing a complex payment processing system. This command triggers multi-persona coordination (architect, frontend, backend, security) and uses Sequential MCP to break down implementation steps. ```bash /sc:implement payment processing system --type feature --with-tests # Multi-persona coordination: architect, frontend, backend, security # Sequential MCP breaks down complex implementation steps ``` -------------------------------- ### Immediate Next Steps for Option C Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/research/pm_agent_roi_analysis_2025-10-21.md If proceeding with Option C (Benchmark First), these immediate steps are required to set up the testing environment and gather baseline data for objective decision-making. ```text 1. Set up HumanEval test environment 2. Run Claude 4.5 baseline on 50 tasks 3. Measure success rate objectively 4. Make data-driven decision ``` -------------------------------- ### User Installation from PyPI Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/architecture/MIGRATION_TO_CLEAN_ARCHITECTURE.md Bash command for installing SuperClaude from PyPI. This is the standard installation method for users once the package is published. ```bash # Install from PyPI (future) pip install superclaude ``` -------------------------------- ### Install UV with pip Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/troubleshooting/serena-installation.md If `uvx` is not available after the curl installation, you can install UV using pip. This ensures that `uvx` is properly set up. ```bash pip install uv ``` -------------------------------- ### Install and Run PM Agent Plugin Source: https://github.com/superclaude-org/superclaude_framework/blob/master/TEST_PLUGIN.md Commands to add the local plugin, install it, and then invoke the PM agent functionality. Run these in a new session. ```bash /plugin marketplace add superclaude-local file:///Users/kazuki/github/superclaude/.claude-plugin ``` ```bash /plugin install pm-agent@superclaude-local ``` ```bash /context ``` ```bash /pm ``` ```bash /context ``` -------------------------------- ### Install SuperClaude using pip Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/getting-started/installation.md Traditional installation method suitable for all platforms, including Windows. Supports both standard and user installations. ```bash # Standard installation pip install SuperClaude # Or user installation pip install --user SuperClaude # Run the installer SuperClaude install ``` -------------------------------- ### Setup New React TypeScript Project Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/reference/basic-examples.md Initialize a new React project with TypeScript, including routing, state management, and testing setup. Optionally, an agent can review and optimize the project structure. ```bash /sc:implement "React TypeScript project with routing, state management, and testing setup" @agent-frontend-architect "review and optimize the project structure" ``` -------------------------------- ### Ruff Configuration Example (pyproject.toml) Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/research/research_python_directory_naming_automation_2025.md Demonstrates how to configure the Ruff linter using a pyproject.toml file. It includes settings for line length, target Python version, file exclusions, and specific linting rules, including per-file ignores for certain patterns. ```toml [tool.ruff] line-length = 88 target-version = "py38" exclude = [ ".git", ".venv", "build", "dist", ] [tool.ruff.lint] select = ["E", "F", "W", "I", "N"] # N = naming conventions ignore = ["E501"] # Line too long [tool.ruff.lint.per-file-ignores] "__init__.py" = ["F401"] # Unused imports OK in __init__.py "tests/*" = ["N802"] # Function name conventions relaxed in tests ``` -------------------------------- ### Verify Package Installation Location Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/architecture/PHASE_1_COMPLETE.md Confirms that the SuperClaude package is installed in the correct site-packages directory. This is a crucial step to ensure a clean, standard installation. ```python import superclaude; print(superclaude.__file__) ``` -------------------------------- ### Testing and Configuration Commands Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/Development/pm-agent-integration.md Commands for running tests and installing prerequisites. ```bash pytest tests/test_pdca_engine.py -v ``` ```bash # Install Serena MCP server # See: docs/troubleshooting/serena-installation.md ``` -------------------------------- ### Set up TWENTYFIRST_API_KEY for Magic Server Source: https://github.com/superclaude-org/superclaude_framework/blob/master/docs/user-guide/mcp-servers.md To use the magic server for UI component generation, set the TWENTYFIRST_API_KEY environment variable. Automatic activation occurs with commands like `/sc:implement` for UI tasks. ```bash # Automatic activation /sc:implement "responsive dashboard component" # → Generates accessible UI with modern patterns # API key setup export TWENTYFIRST_API_KEY="your_key_here" ``` -------------------------------- ### Install UV Package Manager Source: https://github.com/superclaude-org/superclaude_framework/blob/master/KNOWLEDGE.md Installs the 'uv' package manager using a script for macOS/Linux or PowerShell for Windows. Also shows installation via pip. ```bash # macOS/Linux curl -LsSf https://astral.sh/uv/install.sh | sh ``` ```powershell # Windows powershell -c "irm https://astral.sh/uv/install.ps1 | iex" ``` ```bash # With pip pip install uv ```