uuos
文档 / 快速开始

快速开始

本指南带你在本地跑起完整的 uuos:PostgreSQL + Redis 基础设施、Go API 服务与 React 画布前端, 然后创建并运行第一个工作流。全程约 5 分钟。

内测阶段说明:当前仓库为邀请制访问。还没有邀请?写信给我们申请内测名额。

前置要求

  • Go 1.26+
  • Node.js 24+ 与 pnpm 11+
  • Docker 与 Docker Compose
  • PostgreSQL 17(可选——本地开发可用内存模式跳过)

1. 克隆仓库并启动基础设施

git clone https://github.com/uuos-ai/uuos.git
cd uuos

# 启动 PostgreSQL + Redis
docker compose -f deploy/compose.yaml up -d

# 运行数据库迁移
./scripts/migrate.sh

2. 启动后端 API

开发模式使用内存存储和 Mock LLM,无需任何 API Key 即可体验完整流程:

cd services/api
go run . -f etc/uuos-api.yaml

API 默认运行在 http://localhost:8888。要连接 PostgreSQL 和真实 LLM 提供商,改用 etc/uuos-api-postgres.yaml 并在配置中填入 Anthropic / OpenAI 密钥。

3. 启动画布前端

# 在项目根目录
pnpm install
pnpm dev

打开 http://localhost:5173,你会看到画布编辑器。

4. 创建并运行第一个工作流

  1. 从左侧节点库拖入 StartLLMEnd 三个节点并连线。
  2. 选中 LLM 节点,在右侧检查器里选择模型档位(开发模式下由 Mock Provider 响应)。
  3. 点击顶部「运行」,在运行面板里实时看到 SSE 流式输出、逐节点状态与 token 用量。

同一层的多个节点会自动并行执行——试着从 Start 拖出两个 LLM 节点再汇聚到 End,运行面板会显示它们同时开始。

下一步

  • 了解全部 9 种节点类型:LLM、HTTP、Template、Condition、Loop、RAG、SubFlow 等。
  • 阅读 contracts/openapi.yaml,把工作流发布为 REST / SSE API。
  • 使用 Helm Chart 部署到 Kubernetes(deploy/helm/uuos/)。

完整文档站正在建设中,当前以本页 + 仓库内 README 为准。