diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..f2e1b92 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,349 @@ +# 🐾 QwenClaw Installation & Setup Guide + +**Complete guide to installing and using QwenClaw with Qwen Code CLI** + +--- + +## ⚑ Quick Start (5 Minutes) + +### Step 1: Install QwenClaw + +```bash +# Option A: Install globally (recommended) +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 +``` + +### Step 2: Run Setup + +```bash +qwenclaw setup +``` + +### Step 3: Start Using + +**In Terminal:** +```bash +qwenclaw start +qwenclaw status +``` + +**In Qwen Code CLI:** +``` +/qwenclaw:status +/qwenclaw:start +/qwenclaw:send "Check my tasks" +``` + +--- + +## πŸ“‹ Prerequisites + +- **Node.js** version 22 or higher +- **Qwen Code CLI** installed and configured +- **npm** or **bun** package manager + +### Check Node Version + +```bash +node --version # Should be v22.x or higher +``` + +### Install Node.js (if needed) + +- **Windows/macOS:** Download from https://nodejs.org/ +- **Linux:** `curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - && sudo apt-get install -y nodejs` + +--- + +## πŸš€ Installation Methods + +### Method 1: npm (Recommended) + +```bash +# Install globally +npm install -g qwenclaw + +# Verify installation +qwenclaw --version +``` + +### Method 2: From Source + +```bash +# Clone repository +git clone https://github.rommark.dev/admin/QwenClaw-with-Auth.git +cd QwenClaw-with-Auth + +# Install dependencies +npm install + +# Link globally +npm link + +# Verify +qwenclaw --version +``` + +### Method 3: Development Mode + +```bash +# Clone and install +git clone https://github.rommark.dev/admin/QwenClaw-with-Auth.git +cd QwenClaw-with-Auth +npm install + +# Run without installing +npm run start +npm run status +``` + +--- + +## βš™οΈ Configuration + +### Run Setup Wizard + +```bash +qwenclaw setup +``` + +This will: +1. Create `~/.qwen/qwenclaw/` directory +2. Generate default settings +3. Configure Qwen Code integration + +### Manual Configuration + +Create `~/.qwen/qwenclaw/settings.json`: + +```json +{ + "model": "qwen-plus", + "api": "", + "timezone": "UTC", + "heartbeat": { + "enabled": false, + "interval": 15 + }, + "telegram": { + "token": "", + "allowedUserIds": [] + }, + "security": { + "level": "moderate" + }, + "web": { + "enabled": true, + "host": "127.0.0.1", + "port": 4632 + } +} +``` + +--- + +## 🎯 Usage + +### Terminal Commands + +| Command | Description | +|---------|-------------| +| `qwenclaw start` | Start daemon | +| `qwenclaw status` | Check status | +| `qwenclaw send "message"` | Send task | +| `qwenclaw skills` | List skills | +| `qwenclaw help` | Show help | + +### Qwen Code Slash Commands + +After installation, use these inside Qwen Code chat: + +| Command | Description | +|---------|-------------| +| `/qwenclaw:start` | Start daemon | +| `/qwenclaw:status` | Check status | +| `/qwenclaw:send "task"` | Send task | +| `/qwenclaw:skills` | List skills | +| `/qwenclaw:help` | Show help | + +### Examples + +**Start Daemon:** +```bash +qwenclaw start +``` + +**Check Status:** +``` +/qwenclaw:status +``` + +**Send Task:** +```bash +qwenclaw send "Summarize my GitHub notifications" +``` + +**List Skills:** +``` +/qwenclaw:skills +``` + +--- + +## 🌐 Web Dashboard + +Access the web dashboard at: + +``` +http://127.0.0.1:4632 +``` + +Features: +- Real-time daemon status +- Skill management +- Job scheduling +- Logs viewer + +--- + +## πŸ“š Available Skills (81 Total) + +### By Category + +| Category | Count | Examples | +|----------|-------|----------| +| Content | 8 | Research writer, changelog | +| Development | 25 | Code mentor, plugin dev | +| Design | 3 | UI/UX Pro Max, shadcn/ui | +| Automation | 5 | GUI automation | +| Multi-Agent | 2 | Agents Council | +| Economic | 1 | ClawWork (220 tasks) | +| Tools | 10 | QwenBot, file ops | +| Business | 8 | Internal comms | +| Creative | 5 | Theme factory | +| Productivity | 7 | Meeting insights | +| Media | 3 | Image, video | +| Writing | 3 | Resume, brand | +| Social | 2 | Twitter, Slack | +| Community | 1 | AChurch | +| Document | 1 | Document skills | + +### List All Skills + +```bash +qwenclaw skills +``` + +Or in Qwen Code: +``` +/qwenclaw:skills +``` + +--- + +## πŸ”§ Troubleshooting + +### Issue: "command not found: qwenclaw" + +**Solution:** +```bash +# Reinstall globally +npm install -g qwenclaw + +# Or add npm global bin to PATH +# Windows: %APPDATA%\npm +# macOS/Linux: ~/.npm-global/bin +``` + +### Issue: "/qwenclaw:status unknown command" + +**Solution:** +```bash +# Verify commands directory exists +ls -la ~/.qwen/commands/qwenclaw/ + +# Should contain: start.md, status.md, send.md, skills.md, help.md + +# Restart Qwen Code +exit +qwen +``` + +### Issue: "Daemon not running" + +**Solution:** +```bash +# Start daemon +qwenclaw start + +# Or use slash command +/qwenclaw:start +``` + +### Issue: "Skills not available" + +**Solution:** +```bash +# Check skills directory +ls -la ~/.qwen/qwenclaw/skills/ + +# Re-run setup +qwenclaw setup +``` + +--- + +## πŸ“– Additional Resources + +- **GitHub:** https://github.rommark.dev/admin/QwenClaw-with-Auth +- **Issues:** https://github.rommark.dev/admin/QwenClaw-with-Auth/issues +- **OpenClaw:** https://github.com/openclaw/openclaw +- **Qwen Code:** https://github.com/QwenLM/Qwen-Code + +--- + +## πŸ†˜ Getting Help + +### View Help + +```bash +qwenclaw help +``` + +Or in Qwen Code: +``` +/qwenclaw:help +``` + +### Report Issues + +1. Check existing issues: https://github.rommark.dev/admin/QwenClaw-with-Auth/issues +2. Create new issue with: + - QwenClaw version: `qwenclaw --version` + - Node version: `node --version` + - OS and version + - Error message + - Steps to reproduce + +--- + +## βœ… Verification Checklist + +After installation, verify: + +- [ ] `qwenclaw --version` shows version 2.0.1 or higher +- [ ] `qwenclaw status` shows daemon status +- [ ] `/qwenclaw:status` works in Qwen Code +- [ ] Web dashboard accessible at http://127.0.0.1:4632 +- [ ] Skills directory exists: `~/.qwen/qwenclaw/skills/` +- [ ] Commands directory exists: `~/.qwen/commands/qwenclaw/` + +--- + +**You're all set! Start using QwenClaw with `/qwenclaw:status` in Qwen Code!** πŸΎπŸŽ‰ diff --git a/README.md b/README.md index 8d35921..a5b86ca 100644 --- a/README.md +++ b/README.md @@ -6,24 +6,45 @@ Built from [OpenClaw](https://github.com/openclaw/openclaw) β€’ Powered by Qwen --- -## Quick Start +## ⚑ Quick Start (5 Minutes) + +### 1. Install ```bash -# Install globally npm install -g qwenclaw - -# Or use from source -cd qwenclaw -npm link - -# Setup (one-time) -qwenclaw setup - -# Start using -qwenclaw start -qwenclaw send "Check my tasks" ``` +### 2. Setup + +```bash +qwenclaw setup +``` + +### 3. Use + +**In Terminal:** +```bash +qwenclaw start +qwenclaw status +``` + +**In Qwen Code CLI:** +``` +/qwenclaw:status +/qwenclaw:start +/qwenclaw:send "Check my tasks" +``` + +**Web Dashboard:** http://127.0.0.1:4632 + +--- + +## πŸ“– Full Documentation + +- **[INSTALL.md](INSTALL.md)** - Complete installation guide +- **[docs/QWEN-CODE-SETUP.md](docs/QWEN-CODE-SETUP.md)** - Qwen Code integration setup +- **[skills/](skills/)** - All 81+ skills documentation + --- ## Features