v2.0.3: Emphasize global installation in docs
This commit is contained in:
105
INSTALL.md
105
INSTALL.md
@@ -6,26 +6,32 @@
|
||||
|
||||
## ⚡ Quick Start (5 Minutes)
|
||||
|
||||
### Step 1: Install QwenClaw
|
||||
### Step 1: Install QwenClaw Globally
|
||||
|
||||
```bash
|
||||
# Option A: Install globally (recommended)
|
||||
# Recommended: Install globally with npm
|
||||
npm install -g qwenclaw
|
||||
|
||||
# Option B: Use from source
|
||||
git clone https://github.rommark.dev/admin/QwenClaw-with-Auth.git
|
||||
cd QwenClaw-with-Auth
|
||||
npm install
|
||||
npm link
|
||||
# Or use bun
|
||||
bun install -g qwenclaw
|
||||
```
|
||||
|
||||
### Step 2: Run Setup
|
||||
### Step 2: Verify Installation
|
||||
|
||||
```bash
|
||||
# Check version
|
||||
qwenclaw --version
|
||||
|
||||
# Should show: qwenclaw v2.0.2
|
||||
```
|
||||
|
||||
### Step 3: Run Setup
|
||||
|
||||
```bash
|
||||
qwenclaw setup
|
||||
```
|
||||
|
||||
### Step 3: Start Using
|
||||
### Step 4: Start Using
|
||||
|
||||
**In Terminal:**
|
||||
```bash
|
||||
@@ -63,17 +69,34 @@ node --version # Should be v22.x or higher
|
||||
|
||||
## 🚀 Installation Methods
|
||||
|
||||
### Method 1: npm (Recommended)
|
||||
### Method 1: Global Install with npm (Recommended)
|
||||
|
||||
```bash
|
||||
# Install globally
|
||||
# Install globally - makes qwenclaw command available system-wide
|
||||
npm install -g qwenclaw
|
||||
|
||||
# Verify installation
|
||||
qwenclaw --version
|
||||
qwenclaw help
|
||||
```
|
||||
|
||||
### Method 2: From Source
|
||||
**This is the recommended method because:**
|
||||
- ✅ `qwenclaw` command available from anywhere in terminal
|
||||
- ✅ Works with Qwen Code CLI slash commands
|
||||
- ✅ No need to navigate to project directory
|
||||
- ✅ Automatic PATH configuration
|
||||
|
||||
### Method 2: Global Install with bun
|
||||
|
||||
```bash
|
||||
# Install globally with bun
|
||||
bun install -g qwenclaw
|
||||
|
||||
# Verify
|
||||
qwenclaw --version
|
||||
```
|
||||
|
||||
### Method 3: From Source (Development)
|
||||
|
||||
```bash
|
||||
# Clone repository
|
||||
@@ -83,26 +106,29 @@ cd QwenClaw-with-Auth
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Link globally
|
||||
# Link globally (makes it available system-wide)
|
||||
npm link
|
||||
|
||||
# Verify
|
||||
qwenclaw --version
|
||||
```
|
||||
|
||||
### Method 3: Development Mode
|
||||
### Method 4: Local Install (Not Recommended)
|
||||
|
||||
```bash
|
||||
# Clone and install
|
||||
# Clone and install locally
|
||||
git clone https://github.rommark.dev/admin/QwenClaw-with-Auth.git
|
||||
cd QwenClaw-with-Auth
|
||||
npm install
|
||||
|
||||
# Run without installing
|
||||
# Run with npm scripts (must be in project directory)
|
||||
npm run start
|
||||
npm run status
|
||||
npm run help
|
||||
```
|
||||
|
||||
**Note:** This method requires you to be in the project directory. For best experience, use Method 1 (global install).
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Configuration
|
||||
@@ -249,16 +275,50 @@ Or in Qwen Code:
|
||||
|
||||
## 🔧 Troubleshooting
|
||||
|
||||
### Issue: "command not found: qwenclaw"
|
||||
### Issue: "command not found: qwenclaw" or "qwenclaw is not recognized"
|
||||
|
||||
**Cause:** QwenClaw not installed globally or not in PATH
|
||||
|
||||
**Solution:**
|
||||
|
||||
```bash
|
||||
# Reinstall globally
|
||||
# Install globally
|
||||
npm install -g qwenclaw
|
||||
|
||||
# Or add npm global bin to PATH
|
||||
# Windows: %APPDATA%\npm
|
||||
# macOS/Linux: ~/.npm-global/bin
|
||||
# If still not found, add npm global bin to PATH
|
||||
|
||||
# Windows:
|
||||
# Add to System Environment Variables PATH:
|
||||
# %APPDATA%\npm
|
||||
|
||||
# macOS/Linux:
|
||||
export PATH="$HOME/.npm-global/bin:$PATH"
|
||||
# Add above line to ~/.bashrc or ~/.zshrc
|
||||
|
||||
# Verify installation
|
||||
qwenclaw --version
|
||||
```
|
||||
|
||||
**Alternative (Windows PowerShell):**
|
||||
```powershell
|
||||
# Run as Administrator
|
||||
npm install -g qwenclaw
|
||||
|
||||
# Add to PATH
|
||||
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";$env:APPDATA\npm", [EnvironmentVariableTarget]::Machine)
|
||||
```
|
||||
|
||||
### Issue: Permission denied when installing globally
|
||||
|
||||
**Solution:**
|
||||
|
||||
```bash
|
||||
# macOS/Linux - use sudo
|
||||
sudo npm install -g qwenclaw
|
||||
|
||||
# Or configure npm to use user directory
|
||||
npm config set prefix '~/.npm-global'
|
||||
export PATH=~/.npm-global/bin:$PATH
|
||||
```
|
||||
|
||||
### Issue: "/qwenclaw:status unknown command"
|
||||
@@ -270,6 +330,9 @@ ls -la ~/.qwen/commands/qwenclaw/
|
||||
|
||||
# Should contain: start.md, status.md, send.md, skills.md, help.md
|
||||
|
||||
# If missing, re-run setup
|
||||
qwenclaw setup
|
||||
|
||||
# Restart Qwen Code
|
||||
exit
|
||||
qwen
|
||||
|
||||
Reference in New Issue
Block a user