admin/openclaw-manager
1
0
Fork 0
mirror of https://github.com/MrFadiAi/openclaw-manager.git synced 2026-08-14 00:57:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: rewrite README and setup guide with all new features

Browse Source
This commit is contained in:
MrFadiAi
2026-02-15 03:29:15 +01:00
parent a9f4870d1b
commit 8137bfbd9b
2 changed files with 317 additions and 246 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+211 -201
View File
@@ -1,41 +1,65 @@
# 🦞 OpenClaw Manager
High-performance cross-platform AI assistant management tool, built with **Tauri 2.0 + React + TypeScript + Rust**.
**One-click installer & management GUI for [OpenClaw](https://github.com/miaoxworld/OpenClawInstaller)** — the open-source AI assistant framework.
Built with **Tauri 2.0 + React 18 + TypeScript + Rust** for native performance on every desktop platform.
![Platform](https://img.shields.io/badge/platform-macOS%20|%20Windows%20|%20Linux-blue)
![Tauri](https://img.shields.io/badge/Tauri-2.0-orange)
![React](https://img.shields.io/badge/React-18-61DAFB)
![Rust](https://img.shields.io/badge/Rust-1.70+-red)
## 📸 Interface Preview
---
### 📊 Dashboard Overview
## ✨ Key Features
Real-time monitoring of service status, one-click management of AI assistant services.
### 🚀 One-Click Setup Wizard
Skip the terminal entirely. The built-in setup wizard automatically detects your environment, installs Node.js and OpenClaw, and initializes everything — all from the GUI.
- Automatic detection of Node.js, Git, and OpenClaw
- One-click installation of missing prerequisites
- Cross-platform support (Windows, macOS, Linux)
- Guided environment setup with real-time status updates
### 📊 Dashboard & Service Control
Real-time monitoring and full lifecycle management of the OpenClaw service.
![Dashboard](pic/dashboard.png)
- Real-time service status monitoring (port, process ID, memory, uptime)
- Quick actions: Start / Stop / Restart / Diagnose
- Real-time log viewing with auto-refresh support
- Live service status (port, PID, memory usage, uptime)
- **Start / Stop / Restart / Kill All** actions
- Embedded system requirements checker
- Real-time log viewer with auto-refresh
---
### 🧩 MCP Management
Full [Model Context Protocol](https://modelcontextprotocol.io/) server management with integrated **mcporter** support.
- Add, edit, remove, enable/disable MCP servers
- One-click **mcporter** install/uninstall
- Test MCP server connectivity
- Automatic sync to `~/.mcporter/mcporter.json` for seamless OpenClaw integration
- Support for stdio and SSE transport types
### 📚 Skills Management
Browse, install, and manage OpenClaw skills via **ClawHub**.
- One-click **ClawHub** install/uninstall
- Browse available skills from the ClawHub registry
- Install and uninstall individual skills
- View skill metadata (name, description, version)
### 🤖 AI Model Configuration
Flexible configuration of multiple AI providers, supports custom API addresses.
Flexible multi-provider AI configuration with custom endpoint support.
![AI Configuration](pic/ai.png)
- Supports 14+ AI providers (Anthropic, OpenAI, DeepSeek, Moonshot, Gemini, etc.)
- Custom API endpoints, compatible with third-party services using OpenAI format
- One-click primary model setup, quick switching
- **14+ AI providers**: Anthropic, OpenAI, DeepSeek, Google Gemini, Moonshot, Z.AI (GLM), and more
- Custom API endpoints — compatible with any OpenAI-format service
- One-click primary model switching
- API key management
---
### 📱 Message Channel Configuration
Connect to multiple instant messaging platforms to create an omnichannel AI assistant.
### 📱 Message Channels
Connect OpenClaw to multiple messaging platforms for omnichannel AI.
<table>
<tr>
@@ -50,122 +74,33 @@ Connect to multiple instant messaging platforms to create an omnichannel AI assi
</tr>
</table>
- **Telegram** - Bot Token configuration, private chat/group policies
- **Feishu** - App ID/Secret, WebSocket connection, multiple deployment regions
- **More Channels** - Discord, Slack, WhatsApp, iMessage, WeChat, DingTalk
- **Telegram** — Bot Token, private chat & group policies
- **Feishu** — App ID/Secret, WebSocket, multi-region deployment
- **Discord, Slack, WhatsApp, iMessage, WeChat, DingTalk** — and more
### 📋 Application Logs
Built-in structured log viewer with filtering, color-coded levels, and export.
- Filter by level: Debug, Info, Warning, Error
- Color-coded source modules (App, Service, Config, AI, etc.)
- One-click log export and clear
### 🔄 Auto-Update
Automatic update detection for OpenClaw with one-click upgrade.
- Checks npm registry for the latest OpenClaw version
- Compare and display current vs. latest version
- One-click update from within the app
### 🧪 Testing & Diagnostics
Comprehensive system, AI, and channel connectivity testing.
- System environment checks
- AI provider connection tests
- Channel connectivity verification
---
## ✨ Features
| Module | Features |
|--------|----------|
| 📊 **Dashboard** | Real-time service status monitoring, process memory statistics, one-click start/stop/restart |
| 🤖 **AI Configuration** | 14+ AI providers, custom API addresses, quick model switching |
| 📱 **Message Channels** | Telegram, Discord, Slack, Feishu, WeChat, iMessage, DingTalk |
| ⚡ **Service Management** | Background service control, real-time logs, launch on startup |
| 🧪 **Testing & Diagnostics** | System environment check, AI connection test, channel connectivity test |
## 🍎 macOS Common Issues
### "Damaged, cannot be opened" Error
macOS Gatekeeper security mechanism may prevent running unsigned applications. Solutions:
**Method 1: Remove Quarantine Attribute (Recommended)**
```bash
# For .app file
xattr -cr /Applications/OpenClaw\ Manager.app
# Or for .dmg file (before installation)
xattr -cr ~/Downloads/OpenClaw-Manager.dmg
```
**Method 2: Allow via System Preferences**
1. Open **System Preferences** > **Privacy & Security**
2. Find the blocked application in the "Security" section
3. Click **Open Anyway**
**Method 3: Temporarily Disable Gatekeeper (Not Recommended)**
```bash
# Disable (requires administrator password)
sudo spctl --master-disable
# Re-enable after installation
sudo spctl --master-enable
```
### Permission Issues
If the application cannot properly access files or perform operations:
**Grant Full Disk Access**
1. Open **System Preferences** > **Privacy & Security** > **Full Disk Access**
2. Click the lock icon to unlock, add **OpenClaw Manager**
**Reset Permissions**
If permission settings become abnormal, you can try resetting:
```bash
# Reset Accessibility permissions database
sudo tccutil reset Accessibility
# Reset Full Disk Access permissions
sudo tccutil reset SystemPolicyAllFiles
```
## 🚀 Quick Start
### Requirements
- **Node.js** >= 18.0
- **Rust** >= 1.70
- **pnpm** (recommended) or npm
### macOS Additional Dependencies
```bash
xcode-select --install
```
### Windows Additional Dependencies
- [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
- [WebView2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/)
### Linux Additional Dependencies
```bash
# Ubuntu/Debian
sudo apt update
sudo apt install libwebkit2gtk-4.1-dev build-essential curl wget file libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev
# Fedora
sudo dnf install webkit2gtk4.1-devel openssl-devel curl wget file libxdo-devel
```
### Installation and Running
```bash
# Clone the project
git clone https://github.com/miaoxworld/openclaw-manager.git
cd openclaw-manager
# Install dependencies
npm install
# Run in development mode
npm run tauri:dev
# Build release version
npm run tauri:build
```
## 📁 Project Structure
```
@@ -173,26 +108,34 @@ openclaw-manager/
├── src-tauri/ # Rust Backend
│ ├── src/
│ │ ├── main.rs # Entry point
│ │ ├── commands/ # Tauri Commands
│ │ │ ├── service.rs # Service management
│ │ │ ├── config.rs # Configuration management
│ │ ├── commands/
│ │ │ ├── config.rs # Configuration & MCP sync
│ │ │ ├── diagnostics.rs # Diagnostics & testing
│ │ │ ├── installer.rs # Environment detection & one-click installs
│ │ │ ├── process.rs # Process management
│ │ │ └── diagnostics.rs # Diagnostics features
│ │ │ ├── service.rs # Service lifecycle
│ │ │ └── skills.rs # ClawHub & skills management
│ │ ├── models/ # Data models
│ │ └── utils/ # Utility functions
│ │ └── utils/ # Platform helpers & shell utilities
│ ├── Cargo.toml
│ └── tauri.conf.json
│
├── src/ # React Frontend
│ ├── App.tsx
│ ├── App.tsx # Root app with setup wizard & update banner
│ ├── components/
│ │ ├── Layout/ # Layout components
│ │ ├── Dashboard/ # Dashboard
│ │ ├── AIConfig/ # AI configuration
│ │ ├── Channels/ # Channel configuration
│ │ ├── Service/ # Service management
│ │ ├── Testing/ # Testing & diagnostics
│ │ └── Settings/ # Settings
│ │ ├── Layout/ # Sidebar navigation & header
│ │ ├── Dashboard/ # Service status, quick actions, system info
│ │ ├── MCP/ # MCP server management (mcporter)
│ │ ├── Skills/ # Skills management (ClawHub)
│ │ ├── AIConfig/ # AI provider configuration
│ │ ├── Channels/ # Messaging channel configuration
│ │ ├── Testing/ # Diagnostics & connectivity tests
│ │ ├── Logs/ # Structured log viewer
│ │ ├── Setup/ # One-click setup wizard
│ │ └── Settings/ # App settings
│ ├── hooks/ # Custom React hooks
│ ├── lib/ # Tauri API bridge & logger
│ ├── stores/ # Zustand state management
│ └── styles/
│ └── globals.css
│
@@ -201,89 +144,156 @@ openclaw-manager/
└── tailwind.config.js
```
---
## 🛠️ Tech Stack
| Layer | Technology | Description |
|-------|------------|-------------|
| Frontend Framework | React 18 | User Interface |
| State Management | Zustand | Lightweight state management |
| Styling | TailwindCSS | Atomic CSS |
| Animation | Framer Motion | Smooth animations |
| Icons | Lucide React | Beautiful icons |
| Backend | Rust | High-performance system calls |
| Cross-platform | Tauri 2.0 | Native application wrapper |
| Layer | Technology | Purpose |
|-------|------------|---------|
| Frontend | React 18 | UI framework |
| State | Zustand | Lightweight reactive state |
| Styling | TailwindCSS | Utility-first CSS |
| Animation | Framer Motion | Smooth transitions & micro-interactions |
| Icons | Lucide React | Consistent icon set |
| Backend | Rust | High-performance system operations |
| Desktop | Tauri 2.0 | Native cross-platform shell |
## 📦 Build Artifacts
---
After running `npm run tauri:build`, artifacts will be generated in `src-tauri/target/release/bundle/`:
## 🚀 Quick Start (Development)
| Platform | Format |
|----------|--------|
### Prerequisites
| Tool | Version | Download |
|------|---------|----------|
| **Node.js** | >= 18.0 | [nodejs.org](https://nodejs.org/) |
| **Rust** | >= 1.70 | [rustup.rs](https://rustup.rs/) |
| **pnpm** or npm | Latest | Comes with Node.js |
<details>
<summary><b>Platform-specific dependencies</b></summary>
**macOS**
```bash
xcode-select --install
```
**Windows**
- [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
- [WebView2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) *(pre-installed on Windows 10/11)*
**Linux (Ubuntu/Debian)**
```bash
sudo apt update
sudo apt install libwebkit2gtk-4.1-dev build-essential curl wget file \
libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev
```
**Linux (Fedora)**
```bash
sudo dnf install webkit2gtk4.1-devel openssl-devel curl wget file libxdo-devel
```
</details>
### Clone & Run
```bash
git clone https://github.com/MrFadiAi/openclaw-one-click-installer.git
cd openclaw-one-click-installer
npm install # Install dependencies
npm run tauri:dev # Launch in development mode (hot-reload)
```
> **Note:** First build compiles all Rust dependencies and takes **3–5 minutes**. Subsequent runs are much faster.
### Build Release
```bash
npm run tauri:build
```
Output in `src-tauri/target/release/bundle/`:
| Platform | Formats |
|----------|---------|
| macOS | `.dmg`, `.app` |
| Windows | `.msi`, `.exe` |
| Linux | `.deb`, `.AppImage` |
## 🎨 Design Philosophy
- **Dark Theme**: Eye-friendly, suitable for extended use
- **Modern UI**: Frosted glass effects, smooth animations
- **Responsive**: Adapts to different screen sizes
- **High Performance**: Rust backend, minimal memory footprint
---
## 🔧 Development Commands
```bash
# Development mode (hot reload)
npm run tauri:dev
npm run tauri:dev # Full desktop app with hot-reload
npm run dev # Frontend only (browser)
npm run build # Build frontend
npm run tauri:build # Build desktop release
# Run frontend only
npm run dev
# Build frontend
npm run build
# Build complete application
npm run tauri:build
# Check Rust code
cd src-tauri && cargo check
# Run Rust tests
cd src-tauri && cargo test
cd src-tauri && cargo check # Check Rust code
cd src-tauri && cargo test # Run Rust tests
```
## 📝 Configuration Notes
---
### Tauri Configuration (tauri.conf.json)
## 🍎 macOS Troubleshooting
- `app.windows` - Window configuration
- `bundle` - Packaging configuration
- `plugins.shell.scope` - Shell command whitelist
- `plugins.fs.scope` - File access whitelist
<details>
<summary><b>"Damaged, cannot be opened" error</b></summary>
### Environment Variables
macOS Gatekeeper may block unsigned apps.
The application reads environment variable configuration from `~/.openclaw/env`.
**Remove quarantine attribute (recommended):**
```bash
xattr -cr /Applications/OpenClaw\ Manager.app
```
## 🤝 Contributing Guide
**Or allow via System Preferences:**
1. Open **System Preferences** > **Privacy & Security**
2. Find the blocked app → Click **Open Anyway**
</details>
<details>
<summary><b>Permission issues</b></summary>
Grant **Full Disk Access**:
1. **System Preferences** > **Privacy & Security** > **Full Disk Access**
2. Add **OpenClaw Manager**
</details>
---
## 🎨 Design Philosophy
- **Dark Theme** — Eye-friendly for extended sessions
- **Modern UI** — Frosted glass, gradients, smooth animations
- **Responsive** — Adapts to any desktop window size
- **Native Performance** — Rust backend with minimal memory footprint
---
## 🤝 Contributing
1. Fork the project
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Create a Pull Request
## 📄 License
MIT License - See [LICENSE](LICENSE) for details
## 🔗 Related Links
- [OpenClaw Manager](https://github.com/miaoxworld/openclaw-manager) - GUI version (this project)
- [OpenClawInstaller](https://github.com/miaoxworld/OpenClawInstaller) - Command line version
- [Tauri Official Documentation](https://tauri.app/)
- [React Official Documentation](https://react.dev/)
5. Open a Pull Request
---
**Made with ❤️ by OpenClaw Team**
## 📄 License
MIT License — See [LICENSE](LICENSE) for details.
## 🔗 Related Links
- [OpenClaw Manager](https://github.com/MrFadiAi/openclaw-one-click-installer) — This project (GUI)
- [OpenClawInstaller](https://github.com/miaoxworld/OpenClawInstaller) — CLI installer
- [Tauri Documentation](https://tauri.app/)
- [React Documentation](https://react.dev/)
---
**Made with ❤️ by the OpenClaw Community**
SETUP_GUIDE.md
+106 -45
View File
@@ -1,39 +1,81 @@
# 🚀 OpenClaw Manager — Windows Setup Guide
# 🚀 OpenClaw Manager — Setup Guide
## Prerequisites
## For End Users (Download Release)
Install the following before proceeding:
If you downloaded a release build (`.msi`, `.exe`, `.dmg`, or `.AppImage`), just **open the app** — the built-in **Setup Wizard** will automatically:
1. ✅ Detect your operating system
2. ✅ Check for **Node.js** (>= 18) and **Git**
3. ✅ One-click install any missing prerequisites
4. ✅ Install **OpenClaw** and initialize configuration
No terminal required.
---
## For Developers (Build From Source)
### Prerequisites
| Requirement | Version | Download |
|-------------|---------|----------|
| **Node.js** | >= 18.0 | [nodejs.org](https://nodejs.org/) |
| **Rust** | >= 1.70 | [rustup.rs](https://rustup.rs/) |
| **Microsoft C++ Build Tools** | Latest | [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) |
| **WebView2** | Latest | [WebView2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) *(pre-installed on Windows 10/11)* |
| **Git** | Latest | [git-scm.com](https://git-scm.com/) |
> [!TIP]
> You can verify your installations by running:
> Verify installations:
> ```bash
> node --version
> rustc --version
> node --version # Should print v18.x or higher
> rustc --version # Should print 1.70 or higher
> git --version
> ```
---
### Platform-Specific Dependencies
## Step 1 — Open a Terminal in the Project Directory
<details>
<summary><b>🪟 Windows</b></summary>
**This is critical.** You must be inside the project folder before running any commands.
- [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) — select **"Desktop development with C++"** workload
- [WebView2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) *(pre-installed on Windows 10/11)*
</details>
<details>
<summary><b>🍎 macOS</b></summary>
```bash
cd D:\Ai\openclaw-manager
xcode-select --install
```
</details>
> [!CAUTION]
> If you skip this step, `npm install` will fail with `ENOENT: no such file or directory` because it can't find `package.json`.
<details>
<summary><b>🐧 Linux (Ubuntu/Debian)</b></summary>
```bash
sudo apt update
sudo apt install libwebkit2gtk-4.1-dev build-essential curl wget file \
libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev
```
</details>
<details>
<summary><b>🐧 Linux (Fedora)</b></summary>
```bash
sudo dnf install webkit2gtk4.1-devel openssl-devel curl wget file libxdo-devel
```
</details>
---
## Step 2 — Install Dependencies
### Step 1 — Clone the Repository
```bash
git clone https://github.com/MrFadiAi/openclaw-one-click-installer.git
cd openclaw-one-click-installer
```
### Step 2 — Install Dependencies
```bash
npm install
@@ -41,9 +83,7 @@ npm install
This installs all frontend (React, Vite, TailwindCSS) and Tauri CLI dependencies.
---
## Step 3 — Run in Development Mode
### Step 3 — Run in Development Mode
```bash
npm run tauri:dev
@@ -51,57 +91,78 @@ npm run tauri:dev
This will:
1. Start the **Vite** dev server (React frontend with hot-reload)
2. Compile the **Rust** backend (first run takes a few minutes)
2. Compile the **Rust** backend (first run takes 3–5 minutes)
3. Open the native desktop application window
> [!NOTE]
> The first build compiles all Rust dependencies and can take **3–5 minutes**. Subsequent runs are much faster.
> The first build compiles all Rust dependencies and can take **3–5 minutes**. Subsequent runs are much faster due to caching.
---
## Other Useful Commands
Run all commands from `D:\Ai\openclaw-manager`:
## Useful Commands
| Command | Description |
|---------|-------------|
| `npm run dev` | Run frontend only in the browser (no Tauri) |
| `npm run build` | Build the frontend |
| `npm run tauri:build` | Build a release `.msi` / `.exe` installer |
| `npm run tauri:dev` | Full desktop app with hot-reload |
| `npm run tauri:build` | Build release installer (`.msi` / `.exe` / `.dmg`) |
| `cd src-tauri && cargo check` | Check Rust code for errors |
| `cd src-tauri && cargo test` | Run Rust tests |
---
## Troubleshooting
## App Features Overview
### `npm install` fails with `ENOENT`
Make sure you're in the correct directory:
```bash
cd D:\Ai\openclaw-manager
```
Once the app is running, you'll find these sections in the sidebar:
### Tauri version mismatch
If you see errors about mismatched versions (e.g., `tauri (v2.10.x) : @tauri-apps/api (v2.9.x)`), run:
```bash
npm install
```
This will update the dependency versions to match the installed Rust crate.
### Rust compilation errors
Ensure you have the C++ Build Tools installed. Open **Visual Studio Installer** → select **"Desktop development with C++"** workload.
### WebView2 missing
Download and install the [WebView2 Evergreen Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/).
| Page | What It Does |
|------|-------------|
| **Overview** | Service status dashboard, quick actions (start/stop/restart), system requirements panel |
| **MCPs** | Manage MCP servers — add, edit, test, enable/disable. Installs mcporter. Auto-syncs to `~/.mcporter/mcporter.json` |
| **Skills** | Browse and install OpenClaw skills via ClawHub |
| **AI Config** | Configure AI providers (14+), set API keys, choose primary model |
| **Channels** | Set up messaging integrations (Telegram, Discord, Feishu, Slack, etc.) |
| **Testing** | Run system, AI, and channel connectivity diagnostics |
| **Logs** | View structured application logs with level filtering and export |
| **Settings** | General application settings |
---
## Build Output
After `npm run tauri:build`, the installer will be in:
```
src-tauri/target/release/bundle/
├── msi/ → .msi installer
└── nsis/ → .exe installer
├── msi/ → .msi installer (Windows)
├── nsis/ → .exe installer (Windows)
├── dmg/ → .dmg image (macOS)
├── deb/ → .deb package (Linux)
└── appimage/ → .AppImage (Linux)
```
---
## Troubleshooting
### `npm install` fails with `ENOENT`
Make sure you're in the correct project directory.
### Tauri version mismatch
If you see errors about mismatched versions, run `npm install` to update dependencies.
### Rust compilation errors
Ensure you have the C++ Build Tools installed:
- **Windows**: Open Visual Studio Installer → select **"Desktop development with C++"**
- **macOS**: Run `xcode-select --install`
### WebView2 missing (Windows)
Download and install the [WebView2 Evergreen Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/).
### macOS "Damaged, cannot be opened"
```bash
xattr -cr /Applications/OpenClaw\ Manager.app
```
Or go to **System Preferences** > **Privacy & Security** → click **Open Anyway**.