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:
@@ -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 |
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user