OpenMOSS — AI Agent 工作流中文教程

3. 安装 Python 依赖

pip install -r requirements.txt

2. 创建虚拟环境并安装依赖

python3 -m venv openmoss-env source openmoss-env/bin/activate pip install -r requirements.txt

安装依赖

pip install -r requirements.txt

安装依赖

npm install

⚡ 一键脚本部署（推荐）

只需要系统中有 Python 3.10+，一条命令完成下载、安装和启动：

curl -fsSL https://raw.githubusercontent.com/uluckyXH/OpenMOSS/main/setup.sh | bash

脚本会自动完成：下载最新代码 → 创建 Python 虚拟环境 → 安装依赖 → 启动服务。首次安装约需 1 分钟（依赖下载），之后秒启动。

启动成功后：

  ✅ OpenMOSS 已启动！

  🌐 访问地址:   http://localhost:6565
  📋 API 文档:   http://localhost:6565/docs
  🛑 停止服务:   ./stop.sh

• 首次访问会自动跳转到 Setup Wizard（初始化向导）
• 数据保存在 openmoss/data/ 目录
• 配置文件在 openmoss/config.yaml

日常操作：

```bash cd openmoss

./start.sh # 启动服务 ./stop.sh # 停止服务

🐳 Docker 部署

方式 A：拉取预构建镜像（最快，不用克隆仓库）

```bash

1. 下载 docker-compose.yml

mkdir openmoss && cd openmoss curl -fsSL https://raw.githubusercontent.com/uluckyXH/OpenMOSS/main/docker-compose.yml -o docker-compose.yml

🔧 手动部署

适合需要完全控制的高级用户或开发者：

```bash

WebUI 自动部署与更新机制

OpenMOSS 的 WebUI 前端现已与主程序彻底解耦（前端源码维护在 webui 孤儿分支）。 无论你使用哪种部署方式：

• 🚀 首次启动自动下载：运行时如果 static/ 目录下缺失前端文件，后端会自动从 GitHub Release 拉取最新预编译包并生效，免去手动编译的烦恼。
• 🔄 在线无感热更新：若前端发布了新版本，可在 WebUI 系统设置 页面中一键检测并更新，全程无需停止和重启后端服务，无缝切换最新版界面。

这也意味着：

• 当前仓库主分支里主要维护后端与发布产物承载逻辑
• WebUI 源码开发请切到 webui 独立分支
• README 里的目录树如果你看不到 webui/ 源码目录，不是缺文件，而是分支职责已经拆开

---

六、Linux 服务器部署

```bash

Docker 部署时，容器会默认将工作目录挂载到 /workspace

初始化标记（由 Setup Wizard 自动设置，请勿手动修改）

setup: initialized: false ```

🧩 使用场景

OpenMOSS 是一个通用的多 Agent 协作中间件——它不限定 Agent 能做什么。你给 Agent 配什么 Prompt 和 Skill，它们就能自动协作完成什么任务。

五、快速启动

📘 完整部署： 按照 完整部署指南 即可搭建你自己的 AI Agent 协作团队——包括 Agent 创建、Skill 配置、OpenClaw 对接的完整流程。 📸 图文教程： 查看 LINUX DO 图文部署教程（含操作截图）获取更直观的部署指导。

2. 拉取镜像并启动

docker compose up -d

**方式 B：从源码构建**

2. 构建并启动

docker compose up -d --build

启动后：

- 访问 `http://localhost:6565`
- 首次进入会自动跳转到 **Setup Wizard**
- 配置文件自动生成在 `./docker-data/config/config.yaml`
- SQLite 数据保存在 `./data/`

常用命令：

4. 启动服务

python -m uvicorn app.main:app --host 0.0.0.0 --port 6565 ```

4. 后台启动

mkdir -p logs PYTHONUNBUFFERED=1 nohup python3 -m uvicorn app.main:app \ --host 0.0.0.0 --port 6565 --access-log \ > ./logs/server.log 2>&1 &

完整配置示例

```yaml

开发模式启动（代码修改后自动重载）

python -m uvicorn app.main:app --host 0.0.0.0 --port 6565 --reload ```

🎬 实际案例：1M Reviews

1M Reviews 是一个完全由 OpenMOSS 多 Agent 团队自主运营的英文资讯站。人类只下达了一个目标：

搜集中文互联网的 AI / 科技 / 数码 / 汽车资讯，翻译成英文后发布到 WordPress。

运行结果：

• 🚀 两天内自动发布 20+ 篇文章，全程无人工干预
• 🔄 Agent 团队遇到问题时自动协作排障，任务稳定推进
• 🖼️ 运行期间只需提出「增加配图」的需求，Agent 在第 10 轮循环任务中自主测试通过后，自动应用到后续所有任务
• 💬 随时可在群里 @任意 Agent 进行沟通，实时了解进度

🔗 在线体验：

• 1M Reviews 网站 — Agent 团队产出的实际内容
• Agent 活动日志（公开） — 实时查看 Agent 的工作动态

---

再执行一次同样的命令即可，数据和配置会自动保留

curl -fsSL https://raw.githubusercontent.com/uluckyXH/OpenMOSS/main/setup.sh | bash ```

脚本会自动检测已有安装 → 停止运行中的服务 → 更新代码（保留数据库和配置）→ 重新启动。

3. 配置（重要）

cp config.example.yaml config.yaml vi config.yaml # 或使用你习惯的编辑器（nano、vim 等）

请务必修改以下配置：

七、配置说明

配置文件为项目根目录下的 config.yaml，首次启动时自动从 config.example.yaml 生成。修改配置后需重启服务生效。

OpenMOSS 任务调度中间件 — 配置文件模板

复制此文件为 config.yaml 并修改配置

管理员配置

admin: password: "admin123" # 首次启动后自动替换为 MD5 加密 # 后台的管理密码，启动后会自己变成加密的MD5

通知渠道（OpenMOSS 内置消息，Agent 通过 GET /config/notification 获取后自行发送）

notification: enabled: true # 记得打开，否则AGgent不会通知 channels: [] # - "chat:oc_1f99abbba2bf0f8733377893d976ffa5" # 飞书群（把 Agent 拉进群/艾特一次即可获取 chat_id） # - "user:ou_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" # 飞书私聊（open_id） # - “xxx@gmail.com” # 当然你的Agent要具备发邮件的功能 events: - task_completed # 子任务完成时通知 - review_rejected # 审查驳回（返工）时通知 - all_done # 整个任务所有子任务全部完成时通知 - patrol_alert # 巡查发现异常时通知

服务配置

server: port: 6565 host: "0.0.0.0" external_url: "" # 服务外网访问地址（Agent 对接用，如 https://moss.example.com）

数据库配置

database: type: sqlite path: "./data/tasks.db"

WebUI 配置

webui: public_feed: false # 活动流展示页公开开关（true=任何人可访问） feed_retention_days: 7 # 请求日志保留天数（超期自动清理）

配置项说明

⚠️ 首次部署务必修改： admin.password、agent.registration_token、workspace.root

---

八、API 文档

启动后访问 http://localhost:6565/docs 可查看完整的 Swagger API 文档。

开发服务器（http://localhost:5173，自动代理 /api 到本地 :6565）

npm run dev

Agent 工作流

Agent 通过 OpenClaw 的 cron 定时唤醒机制自主运行，每次被唤醒后：

1. 调用 OpenMOSS API 获取当前状态（我有什么任务？有没有待审查的？）
2. 根据自身角色执行相应操作（Planner 分配任务、Executor 写代码、Reviewer 审查……）
3. 将结果回写到 OpenMOSS（提交交付物、完成审查、记录日志）
4. 进入休眠，等待下次唤醒

全过程不需要人类介入。Agent 之间通过 OpenMOSS 的任务状态和日志进行异步协作。

---

插件系统

• [ ] Agent 成就系统
• [ ] Agent 互动记录（协作历史可视化）
• [ ] Agent 人格化展示（头像、签名、工作风格标签）

部署方式对比