mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
📚 Update documentation with pipx installation instructions
- Added pipx as recommended installation method across all docs - Updated troubleshooting guides with PEP 668 error solutions - Added multiple installation options with clear hierarchy - Enhanced error handling instructions with fallback options - Consistent installation instructions throughout documentation
This commit is contained in:
@@ -240,7 +240,7 @@ if command -v SuperClaude &> /dev/null; then
|
|||||||
echo " ✅ SuperClaude installation available"
|
echo " ✅ SuperClaude installation available"
|
||||||
python3 -m SuperClaude --version
|
python3 -m SuperClaude --version
|
||||||
else
|
else
|
||||||
echo " ❌ SuperClaude not found - install with: pip install SuperClaude"
|
echo " ❌ SuperClaude not found - install with: pipx install SuperClaude (or pip install SuperClaude)"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Check context files
|
# Check context files
|
||||||
|
|||||||
@@ -4,13 +4,19 @@ SuperClaude installs behavioral context files that Claude Code reads to enhance
|
|||||||
|
|
||||||
## Quick Start 🚀
|
## Quick Start 🚀
|
||||||
|
|
||||||
**Python (Recommended):**
|
**pipx (Recommended for Linux/macOS):**
|
||||||
|
```bash
|
||||||
|
pipx install SuperClaude
|
||||||
|
SuperClaude install
|
||||||
|
```
|
||||||
|
|
||||||
|
**pip (Traditional):**
|
||||||
```bash
|
```bash
|
||||||
pip install SuperClaude
|
pip install SuperClaude
|
||||||
SuperClaude install
|
SuperClaude install
|
||||||
```
|
```
|
||||||
|
|
||||||
**NPM:**
|
**NPM (Cross-platform):**
|
||||||
```bash
|
```bash
|
||||||
npm install -g @bifrost_inc/superclaude
|
npm install -g @bifrost_inc/superclaude
|
||||||
SuperClaude install
|
SuperClaude install
|
||||||
@@ -24,6 +30,18 @@ pip install -e ".[dev]"
|
|||||||
SuperClaude install --dry-run
|
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
|
## Command Types
|
||||||
|
|
||||||
| Type | Where Used | Format | Example |
|
| Type | Where Used | Format | Example |
|
||||||
|
|||||||
@@ -12,7 +12,14 @@ SuperClaude is a **Context Engineering Framework** that enhances Claude Code by
|
|||||||
|
|
||||||
### 🖥️ Installation - Run in Terminal
|
### 🖥️ Installation - Run in Terminal
|
||||||
```bash
|
```bash
|
||||||
|
# Recommended for Linux/macOS
|
||||||
|
pipx install SuperClaude && SuperClaude install
|
||||||
|
|
||||||
|
# Traditional method
|
||||||
pip install SuperClaude && SuperClaude install
|
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
|
### 💬 First Context Triggers - Type in Claude Code Conversation
|
||||||
|
|||||||
@@ -14,7 +14,12 @@
|
|||||||
|
|
||||||
**New Users**: [Quick Start Guide →](Getting-Started/quick-start.md)
|
**New Users**: [Quick Start Guide →](Getting-Started/quick-start.md)
|
||||||
```bash
|
```bash
|
||||||
|
# Recommended for Linux/macOS
|
||||||
|
pipx install SuperClaude && SuperClaude install
|
||||||
|
|
||||||
|
# Traditional method
|
||||||
pip install SuperClaude && SuperClaude install
|
pip install SuperClaude && SuperClaude install
|
||||||
|
|
||||||
# Then try: /sc:brainstorm "web app idea" in Claude Code
|
# Then try: /sc:brainstorm "web app idea" in Claude Code
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -67,7 +72,12 @@ pip install SuperClaude && SuperClaude install
|
|||||||
|
|
||||||
### In Your Terminal (Installation)
|
### In Your Terminal (Installation)
|
||||||
```bash
|
```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 install # Configure Claude Code
|
||||||
SuperClaude update # Update framework
|
SuperClaude update # Update framework
|
||||||
python3 -m SuperClaude --version # Check installation
|
python3 -m SuperClaude --version # Check installation
|
||||||
|
|||||||
@@ -16,15 +16,27 @@ Test: /sc:brainstorm "test" should ask questions
|
|||||||
python3 -m SuperClaude --version # Should show 4.0.4
|
python3 -m SuperClaude --version # Should show 4.0.4
|
||||||
|
|
||||||
# If not working:
|
# If not working:
|
||||||
|
# For pipx users
|
||||||
|
pipx upgrade SuperClaude
|
||||||
|
|
||||||
|
# For pip users
|
||||||
pip install --upgrade SuperClaude
|
pip install --upgrade SuperClaude
|
||||||
|
|
||||||
|
# Then reinstall
|
||||||
python3 -m SuperClaude install
|
python3 -m SuperClaude install
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Permission Issues
|
### 3. Permission Issues
|
||||||
```bash
|
```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
|
pip install --user SuperClaude
|
||||||
# Or: sudo chown -R $USER ~/.claude
|
|
||||||
|
# Option 3: Fix permissions
|
||||||
|
sudo chown -R $USER ~/.claude
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4. MCP Server Issues
|
### 4. MCP Server Issues
|
||||||
|
|||||||
@@ -29,15 +29,29 @@ SuperClaude install --list-components
|
|||||||
|
|
||||||
**Package Installation Fails:**
|
**Package Installation Fails:**
|
||||||
```bash
|
```bash
|
||||||
|
# For pipx users
|
||||||
|
pipx uninstall SuperClaude
|
||||||
|
pipx install SuperClaude
|
||||||
|
|
||||||
|
# For pip users
|
||||||
pip uninstall SuperClaude
|
pip uninstall SuperClaude
|
||||||
pip install --upgrade pip
|
pip install --upgrade pip
|
||||||
pip install SuperClaude
|
pip install SuperClaude
|
||||||
```
|
```
|
||||||
|
|
||||||
**Permission Denied:**
|
**Permission Denied / PEP 668 Error:**
|
||||||
```bash
|
```bash
|
||||||
|
# Option 1: Use pipx (recommended)
|
||||||
|
pipx install SuperClaude
|
||||||
|
|
||||||
|
# Option 2: Use pip with --user flag
|
||||||
pip install --user SuperClaude
|
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:**
|
**Component Missing:**
|
||||||
|
|||||||
Reference in New Issue
Block a user