快速开始
尽快把 MateClaw 跑起来。
有三种合理的起步方式,它们分别适合不同目标:
- 桌面应用:你是来用产品的
- Docker:你想快速自部署体验
- 本地开发:你准备改代码
先选对起步方式,不要在第一步就把事情复杂化。
先选启动方式
| 方式 | 适合谁 | 启动成本 | 可改代码 |
|---|---|---|---|
| 桌面应用 | 日常使用者 | 最低 | 否 |
| Docker | 快速自部署体验 | 低 | 有限 |
| 本地开发 | 开发者与贡献者 | 最高 | 是 |
启动前你真正需要的东西
一个可用的模型供应商
MateClaw 的价值从“接通一个模型”开始。
推荐起点:
- DashScope:最直接的云端方案
- Ollama:本地模型方案
- OpenAI / Anthropic / Gemini / DeepSeek / Kimi / MiniMax / 智谱 / OpenRouter:如果这些已经在你的体系里
你不需要一次把所有供应商都配好。
你只需要先有一个能工作。
运行要求
桌面版
- 不需要单独安装 Java
- 不需要 Node.js
- 不需要 Maven
Docker
- Docker
- Docker Compose v2+
本地开发
- Java 17+
- Maven 3.9+
- Node.js 18+
- pnpm
方式一:桌面应用
如果你是来体验产品,桌面版是最快的起步方式。
- 从 GitHub Releases 下载最新版本
- 完成安装
- 启动应用
- 等待初始化完成
- 使用默认账号登录:
| 字段 | 值 |
|---|---|
| 用户名 | admin |
| 密码 | admin123 |
然后进入:
设置 -> 模型
配置一个模型供应商,保存后回到对话页即可开始使用。
方式二:Docker
如果你想快速得到一个自部署环境,用 Docker。
bash
git clone https://github.com/matevip/mateclaw.git
cd mateclaw
cp .env.example .env
docker compose up -d访问:
http://localhost:18080
默认登录:
admin/admin123
进入 UI 后再配置一个模型供应商即可。
方式三:本地开发
如果你打算直接在代码层工作,用这个路径。
启动后端
bash
git clone https://github.com/matevip/mateclaw.git
cd mateclaw/mateclaw-server
mvn spring-boot:run后端地址:
- 应用:
http://localhost:18088 - H2 Console:
http://localhost:18088/h2-console - Swagger UI:
http://localhost:18088/swagger-ui.html
启动前端
bash
cd ../mateclaw-ui
pnpm install
pnpm dev前端地址:
- 应用:
http://localhost:5173
默认登录:
admin/admin123
进入:
设置 -> 模型
配置一个模型供应商即可。
第一次启动后的验证清单
系统启动后,确认这 4 件事:
- 能登录
- 至少配置了一个模型供应商
- 对话页能返回消息
- 左侧导航中的 Agents、Tools、MCP、Security 等页面可正常打开
这 4 件事成立,系统就真正活了。
启动后立刻该做什么
不要停在“它能跑起来”。
建议马上做这几件事:
- 在对话页发出第一条消息
- 创建或检查一个 Agent
- 安装一个技能,或接一个 MCP 服务
- 如果你的场景依赖知识资料,建立一个 Wiki 知识库
- 如果工具会接触敏感操作,进入 Security 检查审批规则
