mirror of
https://gitee.com/mateos/mateclaw.git
synced 2026-09-14 03:33:43 +08:00
231 lines
9.2 KiB
Markdown
231 lines
9.2 KiB
Markdown
<div align="center">
|
||
|
||
<p align="center">
|
||
<img src="mateclaw-ui/public/logo/mateclaw_logo_s.png" alt="MateClaw Logo" width="120">
|
||
</p>
|
||
|
||
# MateClaw
|
||
|
||
<p align="center"><b>Build AI that thinks, acts, remembers, and ships.</b></p>
|
||
|
||
[](https://github.com/matevip/mateclaw)
|
||
[](https://claw.mate.vip/docs)
|
||
[](https://claw-demo.mate.vip)
|
||
[](https://claw.mate.vip)
|
||
[](https://adoptium.net/)
|
||
[](https://spring.io/projects/spring-boot)
|
||
[](https://vuejs.org/)
|
||
[](https://github.com/matevip/mateclaw)
|
||
[](LICENSE)
|
||
|
||
[[Website](https://claw.mate.vip)] [[Live Demo](https://claw-demo.mate.vip)] [[Documentation](https://claw.mate.vip/docs)] [[中文](README_zh.md)]
|
||
|
||
</div>
|
||
|
||
<p align="center">
|
||
<img src="assets/images/preview.png" alt="MateClaw Preview" width="800">
|
||
</p>
|
||
|
||
---
|
||
|
||
An AI agent. A knowledge engine. A memory system. A tool runtime. A multi-channel presence.
|
||
|
||
**One product. The whole widget.**
|
||
|
||
MateClaw is a personal AI operating system built with **Java + Vue 3**, powered by [Spring AI Alibaba](https://github.com/alibaba/spring-ai-alibaba). It's not a chatbox, not a workflow builder, not just another coding assistant. It's the entire system — from reasoning to remembering to shipping — in one deployment.
|
||
|
||
Three things make it insanely different:
|
||
|
||
1. **Agents do work, not just talk** — ReAct + Plan-and-Execute. Not one-shot answers — iterative reasoning that actually completes tasks
|
||
2. **Knowledge is shaped, not just stored** — An LLM Wiki that digests raw material into structured, linked pages. The difference between a warehouse and a library
|
||
3. **End-to-end, no compromises** — Web console, desktop app, 7 IM channels, tool guardrails, enterprise auth. One team, one deployment, one experience
|
||
|
||
---
|
||
|
||
## Why MateClaw
|
||
|
||
Most AI tools do one thing well. MateClaw does the whole thing.
|
||
|
||
| Capability | MateClaw | [OpenClaw](https://github.com/openclaw/openclaw) | [CoPaw](https://github.com/agentscope-ai/CoPaw) | [QClaw](https://cntechpost.com/2026/03/20/tencent-opens-qclaw-public-testing-amid-fierce-ai-rivalry/) | [Claude Code](https://github.com/anthropics/claude-code) | [Cursor](https://cursor.com) | [Windsurf](https://windsurf.com) |
|
||
|:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
|
||
| Agent Orchestration | **ReAct + Plan-Execute** | Multi-agent teams | Multi-agent collab | Specialist agents | Parallel agents | Background agents | Cascade engine |
|
||
| Knowledge System | **LLM Wiki (digestion)** | Intelligence Mode + Wiki | Personal KB | Knowledge graph | No | No | No |
|
||
| Memory | **Extract + Consolidate + Dream** | SQLite + Dreaming + Wiki | ReMe (hybrid retrieval) | 3-layer memory | Auto-memory | No | Session only |
|
||
| Tool Guard & Approval | **RBAC + approval flow** | HITL + risk levels | No | No | No | No | No |
|
||
| Multi-Channel IM | **7 channels** | 25+ channels | 7 channels | 5 channels | Terminal only | IDE only | IDE only |
|
||
| Web Management UI | **Full admin dashboard** | Control UI | Console UI | Dashboard | No | No | No |
|
||
| Desktop App | **Electron + bundled JRE** | macOS menu bar | Electron (Beta) | Win/Mac app | CLI | Yes | Yes |
|
||
| Multimodal Creation | **TTS/STT/Img/Music/Video** | TTS/Video/Music/Image | Vision input | No | No | No | No |
|
||
| Skill Ecosystem | **ClawHub marketplace** | ClawHub registry | Python skills | Templates | MCP skills | No | MCP |
|
||
| Enterprise Auth | **RBAC + JWT** | Basic (password) | Basic auth | No | No | Teams plan | Teams plan |
|
||
| Open Source | **Apache 2.0** | MIT | Apache 2.0 | Partial | CLI only | No | No |
|
||
| Pricing | **Free** | Free | Free | Free (beta) | Token-based | $0–200/mo | $0–60/mo |
|
||
| Tech Stack | **Java + Vue 3** | TypeScript | Python + TS | OpenClaw fork | TypeScript | Electron | Electron |
|
||
|
||
**What makes MateClaw different?**
|
||
|
||
Every product in this table is strong in its own right. Here's where MateClaw carves its own space:
|
||
|
||
- **Plan-and-Execute orchestration** — Not just ReAct loops. Break complex work into ordered steps, execute each one, adapt the plan mid-flight. Most competitors stop at single-turn agent calls
|
||
- **LLM Wiki that digests, not just retrieves** — Others index and search. MateClaw's Wiki turns raw material into structured, linked pages with summaries — the difference between a search engine and an encyclopedia
|
||
- **Java ecosystem** — Built for teams already running Spring Boot in production. No Python runtime, no Node.js dependency chain. One JAR, one deploy
|
||
- **Complete admin experience** — Full dashboard for agents, models, tools, skills, channels, security, cron jobs, and token usage. Not a CLI-first afterthought
|
||
- **Multimodal creation suite** — TTS, STT, image, music, and video generation built in. Not plugins — first-class features
|
||
- **Free, forever** — Apache 2.0. No token-based billing, no per-seat pricing, no feature gating
|
||
|
||
---
|
||
|
||
## Architecture
|
||
|
||
<p align="center">
|
||
<img src="assets/architecture-biz-en.svg" alt="Business Architecture" width="800">
|
||
</p>
|
||
|
||
<details>
|
||
<summary><b>Technical Architecture</b></summary>
|
||
<p align="center">
|
||
<img src="assets/architecture-tech-en.svg" alt="Technical Architecture" width="800">
|
||
</p>
|
||
</details>
|
||
|
||
---
|
||
|
||
## Core Capabilities
|
||
|
||
### Agent Runtime
|
||
|
||
- **ReAct agents** — Think, act, observe, repeat. Iterative reasoning that gets things done
|
||
- **Plan-and-Execute** — Decompose complex work into ordered steps, then execute each one
|
||
- **Dynamic configuration** — Load agent personality, tools, and constraints from the database at runtime
|
||
- **Runtime resilience** — Context pruning, smart truncation, stale stream cleanup, and recovery
|
||
|
||
### Knowledge & Memory
|
||
|
||
- **LLM Wiki** — AI-powered knowledge base that digests raw materials into structured, linked pages with summaries
|
||
- **Workspace memory** — `AGENTS.md`, `SOUL.md`, `PROFILE.md`, `MEMORY.md`, daily notes
|
||
- **Memory lifecycle** — Post-conversation extraction, scheduled consolidation, dreaming workflows
|
||
- **Compound memory** — Understanding improves over time instead of resetting every query
|
||
|
||
### Tools, Skills & MCP
|
||
|
||
- **Built-in tools** — Web search, file ops, memory access, date/time, and more
|
||
- **MCP integration** — stdio, SSE, and Streamable HTTP transports
|
||
- **Skill system** — Installable `SKILL.md` packages with ClawHub marketplace
|
||
- **Tool guard** — Approval flows, file-path protection, runtime filtering
|
||
|
||
### Multimodal Creation
|
||
|
||
Text-to-speech · Speech-to-text · Image generation · Music generation · Video generation
|
||
|
||
### Model Flexibility
|
||
|
||
14+ providers including DashScope, OpenAI, Anthropic, Gemini, DeepSeek, Kimi, Ollama, LM Studio, MLX, and more. Configure everything in the web UI.
|
||
|
||
### Surfaces
|
||
|
||
- **Web console** — Chat, agents, tools, skills, knowledge, models, security, settings
|
||
- **Desktop app** — Electron with bundled JRE 21, no Java installation needed
|
||
- **Channels** — DingTalk, Feishu, WeChat Work, Telegram, Discord, QQ
|
||
|
||
---
|
||
|
||
## Quick Start
|
||
|
||
### Prerequisites
|
||
|
||
- Java 17+ · Node.js 18+ · pnpm · Maven 3.9+
|
||
|
||
### Local Development
|
||
|
||
```bash
|
||
# Backend
|
||
cd mateclaw-server
|
||
mvn spring-boot:run # http://localhost:18088
|
||
|
||
# Frontend
|
||
cd mateclaw-ui
|
||
pnpm install && pnpm dev # http://localhost:5173
|
||
```
|
||
|
||
Login: `admin` / `admin123`
|
||
|
||
### Docker
|
||
|
||
```bash
|
||
cp .env.example .env
|
||
docker compose up -d # http://localhost:18080
|
||
```
|
||
|
||
### Desktop App
|
||
|
||
Download from [GitHub Releases](https://github.com/matevip/mateclaw/releases). Bundles JRE 21 — no Java needed.
|
||
|
||
---
|
||
|
||
## Tech Stack
|
||
|
||
| Layer | Technology |
|
||
|-------|------------|
|
||
| Backend | Spring Boot 3.5 · Spring AI Alibaba 1.1 |
|
||
| Agent | StateGraph Runtime |
|
||
| Database | H2 (dev) / MySQL 8.0+ (prod) |
|
||
| ORM | MyBatis Plus 3.5 |
|
||
| Auth | Spring Security + JWT |
|
||
| Frontend | Vue 3 · TypeScript · Vite |
|
||
| UI | Element Plus · TailwindCSS 4 |
|
||
| Desktop | Electron · electron-updater |
|
||
|
||
---
|
||
|
||
## Project Structure
|
||
|
||
```
|
||
mateclaw/
|
||
├── mateclaw-server/ Spring Boot backend
|
||
├── mateclaw-ui/ Vue 3 SPA frontend
|
||
├── mateclaw-desktop/ Electron desktop app
|
||
├── docker-compose.yml
|
||
└── .env.example
|
||
```
|
||
|
||
---
|
||
|
||
## Documentation
|
||
|
||
Full docs at **[claw.mate.vip/docs](https://claw.mate.vip/docs)**
|
||
|
||
---
|
||
|
||
## Roadmap
|
||
|
||
- Richer multi-agent collaboration
|
||
- Smarter model routing
|
||
- Deeper multimodal understanding
|
||
- Stronger long-term memory
|
||
- Richer ClawHub ecosystem
|
||
|
||
---
|
||
|
||
## Contributing
|
||
|
||
```bash
|
||
git clone https://github.com/matevip/mateclaw.git
|
||
cd mateclaw
|
||
cd mateclaw-server && mvn clean compile
|
||
cd ../mateclaw-ui && pnpm install && pnpm dev
|
||
```
|
||
|
||
---
|
||
|
||
## Why The Name
|
||
|
||
**Mate** is companion. **Claw** is capability.
|
||
|
||
A system that stays with you, and a system that grabs work and moves it.
|
||
|
||
---
|
||
|
||
## License
|
||
|
||
[Apache License 2.0](LICENSE)
|