mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
Updated installation-guide.md (#180)
Update installation-guide.md Signed-off-by: Prashanth681 <rprashanth681@gmail.com>
This commit is contained in:
@@ -4,13 +4,48 @@
|
|||||||
|
|
||||||
**The honest truth**: This guide looks long because we want to cover all the details, but installation is actually pretty simple. Most people are done in 2 minutes with one command!
|
**The honest truth**: This guide looks long because we want to cover all the details, but installation is actually pretty simple. Most people are done in 2 minutes with one command!
|
||||||
|
|
||||||
**TL;DR for the impatient:**
|
### Step 1: Install the Package
|
||||||
|
|
||||||
|
**Option A: From PyPI (Recommended)**
|
||||||
```bash
|
```bash
|
||||||
pip install SuperClaude
|
uv add SuperClaude
|
||||||
SuperClaude install --quick
|
```
|
||||||
# That's it! 🎉
|
|
||||||
|
**Option B: From Source**
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/NomenAK/SuperClaude.git
|
||||||
|
cd SuperClaude
|
||||||
|
uv sync
|
||||||
|
```
|
||||||
|
### 🔧 UV / UVX Setup Guide
|
||||||
|
|
||||||
|
SuperClaude v3 also supports installation via [`uv`](https://github.com/astral-sh/uv) (a faster, modern Python package manager) or `uvx` for cross-platform usage.
|
||||||
|
|
||||||
|
### 🌀 Install with `uv`
|
||||||
|
|
||||||
|
Make sure `uv` is installed:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -Ls https://astral.sh/uv/install.sh | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
> Or follow instructions from: [https://github.com/astral-sh/uv](https://github.com/astral-sh/uv)
|
||||||
|
|
||||||
|
Once `uv` is available, you can install SuperClaude like this:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv venv
|
||||||
|
source .venv/bin/activate
|
||||||
|
uv pip install SuperClaude
|
||||||
|
```
|
||||||
|
|
||||||
|
### ⚡ Install with `uvx` (Cross-platform CLI)
|
||||||
|
|
||||||
|
If you’re using `uvx`, just run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uvx pip install SuperClaude
|
||||||
```
|
```
|
||||||
---
|
|
||||||
## 🔧 UV / UVX Setup Guide
|
## 🔧 UV / UVX Setup Guide
|
||||||
|
|
||||||
SuperClaude v3 also supports installation via [`uv`](https://github.com/astral-sh/uv) (a faster, modern Python package manager) or `uvx` for cross-platform usage.
|
SuperClaude v3 also supports installation via [`uv`](https://github.com/astral-sh/uv) (a faster, modern Python package manager) or `uvx` for cross-platform usage.
|
||||||
|
|||||||
Reference in New Issue
Block a user