External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-29 16:16:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update installation-guide.md

Browse Source 
Signed-off-by: Mithun Gowda B <mithungowda.b7411@gmail.com>
This commit is contained in:
Mithun Gowda B
2025-07-17 12:20:19 +05:30
committed by GitHub
parent 63fbd634de
commit a9ffe19834
1 changed files with 71 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
Docs/installation-guide.md
View File

@@ -6,10 +6,14 @@
**TL;DR for the impatient:** **TL;DR for the impatient:**
```bash ```bash
git clone <repository-url> && cd SuperClaude pip install SuperClaude
python3 SuperClaude.py install --quick SuperClaude install --quick
# That's it! 🎉 # That's it! 🎉
``` ```
### ⚠️ Important Note
**After installing the SuperClaude.**
**You can use `SuperClaude commands`
, `python3 -m SuperClaude commands` or also `python3 SuperClaude commands`**
**What just happened?** SuperClaude tried to set up everything you need. Usually no complex configuration, dependency hunting, or setup headaches! 🎉 **What just happened?** SuperClaude tried to set up everything you need. Usually no complex configuration, dependency hunting, or setup headaches! 🎉
@@ -51,17 +55,31 @@ If any of these fail, see the [Prerequisites Setup](#prerequisites-setup-🛠️
## Quick Start 🚀 ## Quick Start 🚀
**🏆 The "Just Get It Working" Approach (Recommended for 90% of Users)** **🏆 The "Just Get It Working" Approach (Recommended for 90% of Users)**
**Option A: From PyPI (Recommended)**
```bash
pip install SuperClaude
# Install with recommended settings
SuperClaude install --quick
# That's it! 🎉
```
**Option B: From Source**
```bash ```bash
# Clone the repo # Clone the repo
git clone <repository-url> git clone <repository-url>
cd SuperClaude cd SuperClaude
pip install .
# Install with recommended settings # Install with recommended settings
python3 SuperClaude.py install --quick SuperClaude install --quick
# That's it! 🎉 # That's it! 🎉
``` ```
**⚠️ Important Note**
**After installing the SuperClaude.**
**You can use `SuperClaude commands`
, `python3 -m SuperClaude commands` or also `python3 SuperClaude commands`**
**What you just got:** **What you just got:**
- ✅ All 16 smart commands that auto-activate experts - ✅ All 16 smart commands that auto-activate experts
@@ -73,7 +91,7 @@ python3 SuperClaude.py install --quick
**Nervous about what it will do?** See first with: **Nervous about what it will do?** See first with:
```bash ```bash
python3 SuperClaude.py install --quick --dry-run SuperClaude install --quick --dry-run
``` ```
## Installation Options 🎯 ## Installation Options 🎯
@@ -82,7 +100,7 @@ We have three installation profiles to choose from:
### 🎯 Minimal Installation ### 🎯 Minimal Installation
```bash ```bash
python3 SuperClaude.py install --minimal SuperClaude install --minimal
``` ```
- **What**: Just the core framework files - **What**: Just the core framework files
- **Time**: ~1 minute - **Time**: ~1 minute
@@ -92,7 +110,7 @@ python3 SuperClaude.py install --minimal
### 🚀 Quick Installation (Recommended) ### 🚀 Quick Installation (Recommended)
```bash ```bash
python3 SuperClaude.py install --quick SuperClaude install --quick
``` ```
- **What**: Core framework + 16 slash commands - **What**: Core framework + 16 slash commands
- **Time**: ~2 minutes - **Time**: ~2 minutes
@@ -102,7 +120,7 @@ python3 SuperClaude.py install --quick
### 🔧 Developer Installation ### 🔧 Developer Installation
```bash ```bash
python3 SuperClaude.py install --profile developer SuperClaude install --profile developer
``` ```
- **What**: Everything including MCP server integration - **What**: Everything including MCP server integration
- **Time**: ~5 minutes - **Time**: ~5 minutes
@@ -112,7 +130,7 @@ python3 SuperClaude.py install --profile developer
### 🎛️ Interactive Installation ### 🎛️ Interactive Installation
```bash ```bash
python3 SuperClaude.py install SuperClaude install
``` ```
- Lets you pick and choose components - Lets you pick and choose components
- Shows detailed descriptions of what each component does - Shows detailed descriptions of what each component does
@@ -132,6 +150,8 @@ brew install python3
# Windows # Windows
# Download from https://python.org/downloads/ # Download from https://python.org/downloads/
#or open command prompt or powershell
winget install python
``` ```
**Missing Claude CLI?** **Missing Claude CLI?**
@@ -148,23 +168,32 @@ brew install node
# Windows # Windows
# Download from https://nodejs.org/ # Download from https://nodejs.org/
#or open command prompt or powershell
winget install nodejs
``` ```
### Getting SuperClaude 📥 ### Getting SuperClaude 📥
**Option 1: Download the latest release** **Option 1: From PyPI (Recommended)**
```bash
pip install SuperClaude
```
**Option 2: Download the latest release**
```bash ```bash
# Download and extract the latest release # Download and extract the latest release
# (Replace URL with actual release URL) # (Replace URL with actual release URL)
curl -L <release-url> -o superclaude-v3.zip curl -L <release-url> -o superclaude-v3.zip
unzip superclaude-v3.zip unzip superclaude-v3.zip
cd superclaude-v3 cd superclaude-v3
pip install .
``` ```
**Option 2: Clone from Git** **Option 3: Clone from Git**
```bash ```bash
git clone <repository-url> git clone <repository-url>
cd SuperClaude cd SuperClaude
pip install .
``` ```
### Running the Installer 🎬 ### Running the Installer 🎬
@@ -173,19 +202,19 @@ The installer is pretty smart and will guide you through the process:
```bash ```bash
# See all available options # See all available options
python3 SuperClaude.py install --help SuperClaude install --help
# Quick installation (recommended) # Quick installation (recommended)
python3 SuperClaude.py install --quick SuperClaude install --quick
# Want to see what would happen first? # Want to see what would happen first?
python3 SuperClaude.py install --quick --dry-run SuperClaude install --quick --dry-run
# Install everything # Install everything
python3 SuperClaude.py install --profile developer SuperClaude install --profile developer
# Quiet installation (minimal output) # Quiet installation (minimal output)
python3 SuperClaude.py install --quick --quiet SuperClaude install --quick --quiet
# Force installation (skip confirmations) # Force installation (skip confirmations)
python3 SuperClaude.py install --quick --force python3 SuperClaude.py install --quick --force
@@ -273,16 +302,16 @@ Keep SuperClaude up to date:
```bash ```bash
# Check for updates # Check for updates
python3 SuperClaude.py update SuperClaude update
# Force update (overwrite local changes) # Force update (overwrite local changes)
python3 SuperClaude.py update --force SuperClaude update --force
# Update specific components only # Update specific components only
python3 SuperClaude.py update --components core,commands SuperClaude update --components core,commands
# See what would be updated # See what would be updated
python3 SuperClaude.py update --dry-run SuperClaude update --dry-run
``` ```
**When to update:** **When to update:**
@@ -296,16 +325,16 @@ Create backups before major changes:
```bash ```bash
# Create a backup # Create a backup
python3 SuperClaude.py backup --create SuperClaude backup --create
# List existing backups # List existing backups
python3 SuperClaude.py backup --list SuperClaude backup --list
# Restore from backup # Restore from backup
python3 SuperClaude.py backup --restore SuperClaude backup --restore
# Create backup with custom name # Create backup with custom name
python3 SuperClaude.py backup --create --name "before-update" SuperClaude backup --create --name "before-update"
``` ```
**When to backup:** **When to backup:**
@@ -320,13 +349,13 @@ If you need to remove SuperClaude:
```bash ```bash
# Remove SuperClaude (keeps backups) # Remove SuperClaude (keeps backups)
python3 SuperClaude.py uninstall SuperClaude uninstall
# Complete removal (removes everything) # Complete removal (removes everything)
python3 SuperClaude.py uninstall --complete SuperClaude uninstall --complete
# See what would be removed # See what would be removed
python3 SuperClaude.py uninstall --dry-run SuperClaude uninstall --dry-run
``` ```
**What gets removed:** **What gets removed:**
@@ -374,10 +403,10 @@ ls -la ~/.claude/
**"Installation fails partway through"** **"Installation fails partway through"**
```bash ```bash
# Try with verbose output to see what's happening # Try with verbose output to see what's happening
python3 SuperClaude.py install --quick --verbose SuperClaude install --quick --verbose
# Or try a dry run first # Or try a dry run first
python3 SuperClaude.py install --quick --dry-run SuperClaude install --quick --dry-run
``` ```
### Platform-Specific Issues 🖥️ ### Platform-Specific Issues 🖥️
@@ -400,7 +429,7 @@ python3 SuperClaude.py install --quick --dry-run
### Still Having Issues? 🤔 ### Still Having Issues? 🤔
**Check our troubleshooting resources:** **Check our troubleshooting resources:**
- GitHub Issues: https://github.com/your-repo/SuperClaude/issues - GitHub Issues: https://github.com/NomenAK/SuperClaude/issues
- Look for existing issues similar to yours - Look for existing issues similar to yours
- Create a new issue if you can't find a solution - Create a new issue if you can't find a solution
@@ -423,24 +452,24 @@ python3 SuperClaude.py install --quick --dry-run
```bash ```bash
# Install to custom location # Install to custom location
python3 SuperClaude.py install --quick --install-dir /custom/path SuperClaude install --quick --install-dir /custom/path
# Use environment variable # Use environment variable
export SUPERCLAUDE_DIR=/custom/path export SUPERCLAUDE_DIR=/custom/path
python3 SuperClaude.py install --quick SuperClaude install --quick
``` ```
### Component Selection ### Component Selection
```bash ```bash
# See available components # See available components
python3 SuperClaude.py install --list-components SuperClaude install --list-components
# Install specific components only # Install specific components only
python3 SuperClaude.py install --components core,commands SuperClaude install --components core,commands
# Skip certain components # Skip certain components
python3 SuperClaude.py install --quick --skip mcp SuperClaude install --quick --skip mcp
``` ```
### Development Setup ### Development Setup
@@ -449,13 +478,13 @@ If you're planning to contribute or modify SuperClaude:
```bash ```bash
# Developer installation with all components # Developer installation with all components
python3 SuperClaude.py install --profile developer SuperClaude install --profile developer
# Install in development mode (symlinks instead of copies) # Install in development mode (symlinks instead of copies)
python3 SuperClaude.py install --profile developer --dev-mode SuperClaude install --profile developer --dev-mode
# Install with git hooks for development # Install with git hooks for development
python3 SuperClaude.py install --profile developer --dev-hooks SuperClaude install --profile developer --dev-hooks
``` ```
## What's Next? 🚀 ## What's Next? 🚀
@@ -481,9 +510,13 @@ python3 SuperClaude.py install --profile developer --dev-hooks
- **Works alongside existing tools** - doesn't interfere with your setup - **Works alongside existing tools** - doesn't interfere with your setup
- **Easy to uninstall** if you change your mind - **Easy to uninstall** if you change your mind
- **Community supported** - we actually read and respond to issues - **Community supported** - we actually read and respond to issues
- ### ⚠️ Important Note
**After installing the SuperClaude.**
**You can use `SuperClaude commands`
, `python3 -m SuperClaude commands` or also `python3 SuperClaude commands`**
Thanks for trying SuperClaude! We hope it makes your development workflow a bit smoother. 🙂 Thanks for trying SuperClaude! We hope it makes your development workflow a bit smoother. 🙂
--- ---
*Last updated: July 2024 - Let us know if anything in this guide is wrong or confusing!* *Last updated: July 2024 - Let us know if anything in this guide is wrong or confusing!*