跳转至

快速开始

环境要求

工具 版本
Node.js 20+
pnpm 10+
Docker + docker compose 最新稳定版

安装与启动

第 1 步：安装依赖

pnpm install

第 2 步：启动基础设施

启动 PostgreSQL 和 Redis（开发用 Docker Compose）：

pnpm infra:up

第 3 步：启动后端

pnpm dev:server -- --config ./server.example.yaml

服务默认监听 http://127.0.0.1:8787，内嵌 Worker 自动启动。

第 4 步：启动调试控制台

pnpm dev:web

打开 http://localhost:5174。

验证是否正常

启动成功后检查以下几点：

  1. 后端日志显示运行模式（embedded worker / api-only）
  2. 浏览器能打开 http://localhost:5174
  3. 在控制台发送消息，Run 从 queued 进入执行状态

Tip

如果后端地址不是默认值，启动前端时指定代理目标： 

OAH_WEB_PROXY_TARGET=http://127.0.0.1:8787 pnpm dev:web

Single Workspace 模式

只服务一个 Workspace 时，跳过配置文件，直接指定路径：

pnpm dev:server -- \
  --workspace /absolute/path/to/workspace \
  --model-dir /absolute/path/to/models \
  --default-model openai-default

可选参数：--workspace-kind chat、--tool-dir、--skill-dir、--host、--port

Info

Single Workspace 模式下，调试控制台会自动进入唯一的 Workspace。

常用命令

命令 作用
pnpm install 安装依赖
pnpm infra:up 启动 PostgreSQL + Redis
pnpm infra:down 停止基础设施
pnpm dev:server -- --config ./server.example.yaml 启动后端（内嵌 Worker）
pnpm dev:server -- --api-only --config ./server.example.yaml 仅启动 API
pnpm dev:worker -- --config ./server.example.yaml 单独启动 Worker
pnpm dev:web 启动调试控制台
pnpm build 全量构建
pnpm test 运行测试
mkdocs serve 本地预览文档站

接下来