diff --git a/Docs/Developer-Guide/testing-debugging.md b/Docs/Developer-Guide/testing-debugging.md index c497446..15f0caf 100644 --- a/Docs/Developer-Guide/testing-debugging.md +++ b/Docs/Developer-Guide/testing-debugging.md @@ -240,7 +240,7 @@ if command -v SuperClaude &> /dev/null; then echo " ✅ SuperClaude installation available" python3 -m SuperClaude --version else - echo " ❌ SuperClaude not found - install with: pip install SuperClaude" + echo " ❌ SuperClaude not found - install with: pipx install SuperClaude (or pip install SuperClaude)" fi # Check context files diff --git a/Docs/Getting-Started/installation.md b/Docs/Getting-Started/installation.md index 4bd39f3..5035155 100644 --- a/Docs/Getting-Started/installation.md +++ b/Docs/Getting-Started/installation.md @@ -4,13 +4,19 @@ SuperClaude installs behavioral context files that Claude Code reads to enhance ## Quick Start 🚀 -**Python (Recommended):** +**pipx (Recommended for Linux/macOS):** +```bash +pipx install SuperClaude +SuperClaude install +``` + +**pip (Traditional):** ```bash pip install SuperClaude SuperClaude install ``` -**NPM:** +**NPM (Cross-platform):** ```bash npm install -g @bifrost_inc/superclaude SuperClaude install @@ -24,6 +30,18 @@ pip install -e ".[dev]" SuperClaude install --dry-run ``` +**If you encounter PEP 668 errors:** +```bash +# Option 1: Use pipx (recommended) +pipx install SuperClaude + +# Option 2: Use pip with --user flag +pip install --user SuperClaude + +# Option 3: Force installation (use with caution) +pip install --break-system-packages SuperClaude +``` + ## Command Types | Type | Where Used | Format | Example | diff --git a/Docs/Getting-Started/quick-start.md b/Docs/Getting-Started/quick-start.md index c7de2c8..353fb23 100644 --- a/Docs/Getting-Started/quick-start.md +++ b/Docs/Getting-Started/quick-start.md @@ -12,7 +12,14 @@ SuperClaude is a **Context Engineering Framework** that enhances Claude Code by ### 🖥️ Installation - Run in Terminal ```bash +# Recommended for Linux/macOS +pipx install SuperClaude && SuperClaude install + +# Traditional method pip install SuperClaude && SuperClaude install + +# Cross-platform via NPM +npm install -g @bifrost_inc/superclaude && superclaude install ``` ### 💬 First Context Triggers - Type in Claude Code Conversation diff --git a/Docs/README.md b/Docs/README.md index 1b6737d..af84744 100644 --- a/Docs/README.md +++ b/Docs/README.md @@ -14,7 +14,12 @@ **New Users**: [Quick Start Guide →](Getting-Started/quick-start.md) ```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 ``` @@ -67,7 +72,12 @@ pip install SuperClaude && SuperClaude install ### In Your Terminal (Installation) ```bash -pip install SuperClaude # Install framework +# Install framework (choose one) +pipx install SuperClaude # Recommended for Linux/macOS +pip install SuperClaude # Traditional method +npm install -g @bifrost_inc/superclaude # Cross-platform + +# Configure and maintain SuperClaude install # Configure Claude Code SuperClaude update # Update framework python3 -m SuperClaude --version # Check installation diff --git a/Docs/Reference/common-issues.md b/Docs/Reference/common-issues.md index d7d9abc..e2575d4 100644 --- a/Docs/Reference/common-issues.md +++ b/Docs/Reference/common-issues.md @@ -16,15 +16,27 @@ Test: /sc:brainstorm "test" should ask questions python3 -m SuperClaude --version # Should show 4.0.4 # If not working: +# For pipx users +pipx upgrade SuperClaude + +# For pip users pip install --upgrade SuperClaude + +# Then reinstall python3 -m SuperClaude install ``` ### 3. Permission Issues ```bash -# Permission denied errors: +# Permission denied / PEP 668 errors: +# Option 1: Use pipx (recommended) +pipx install SuperClaude + +# Option 2: Use pip with --user pip install --user SuperClaude -# Or: sudo chown -R $USER ~/.claude + +# Option 3: Fix permissions +sudo chown -R $USER ~/.claude ``` ### 4. MCP Server Issues diff --git a/Docs/Reference/troubleshooting.md b/Docs/Reference/troubleshooting.md index f69cd40..661ed39 100644 --- a/Docs/Reference/troubleshooting.md +++ b/Docs/Reference/troubleshooting.md @@ -29,15 +29,29 @@ SuperClaude install --list-components **Package Installation Fails:** ```bash +# For pipx users +pipx uninstall SuperClaude +pipx install SuperClaude + +# For pip users pip uninstall SuperClaude pip install --upgrade pip pip install SuperClaude ``` -**Permission Denied:** +**Permission Denied / PEP 668 Error:** ```bash +# Option 1: Use pipx (recommended) +pipx install SuperClaude + +# Option 2: Use pip with --user flag pip install --user SuperClaude -# Or: sudo chown -R $USER ~/.claude + +# Option 3: Fix permissions +sudo chown -R $USER ~/.claude + +# Option 4: Force installation (use with caution) +pip install --break-system-packages SuperClaude ``` **Component Missing:**