跳到正文
3 分钟

开始使用

根据目标选择 Runtime、Collaboration、CLI 或 Worktree,并找到对应的 Univer 文档入口。

Univer 是一套用于构建人类与 AI Agent 共同操作 Office 内容的 SDK。Runtime 提供 Web 编辑器,Collaboration SDK 提供自托管的权威协同服务,CLI SDK 让 Agent 读取和修改同一个 Unit;配合 Worktree,Agent 可以提交隔离、可审阅、可合入的修改。

根据目标选择入口

目标使用开始
嵌入 Office 编辑器Runtime SDK 展示和编辑 Sheet、Doc、Slide、Board 与 BaseRuntime 快速开始
增加自托管实时协同Collaboration SDK 让多个 Client 共同编辑一个权威 UnitCollaboration SDK 快速开始
让 Agent 读取和修改内容CLI SDK 在 Node.js 中检查、编辑和验证 UnitCLI SDK 概览
让 Agent 修改可审阅、可合入Worktree 隔离修改,并支持人类审阅后合入 trunkWorktree 完整工作流

两个文档站如何分工

文档入口负责的内容
docs.univer.aiRuntime SDK、前端编辑器能力、Preset、Plugin、Facade API 与 API 参考
office.univer.ai应用架构、自托管 Collaboration SDK、CLI SDK 与 Agent Worktree

两个站点描述的是同一套 Univer 技术栈。构建 Web 编辑器时从 Runtime 文档开始;为现有 Web 应用增加新的自托管协同后端时,回到本站的 Collaboration SDK 文档。

完整应用如何组合

一个同时支持人类编辑与 Agent 操作的应用通常由 Web、CLI 与 Server 组成:

Web 提供展示、交互式编辑和人工审阅;CLI 为 Agent 提供内容操作入口;Server 是两者共享的 内容权威。三个组件可以按需裁剪,也可以全部部署在本机。完整边界见 Univer SDK 概览

推荐按目标逐步增加能力:

  1. 先通过 Runtime 文档建立一个可编辑的 Web 应用。
  2. 需要多人同步时,完成 Collaboration SDK 快速开始
  3. 需要 Agent 入口时,完成 CLI 内容加载与读写
  4. 需要隔离修改和人工审阅时,再增加 Worktree

示例集合

教学示例

实际应用示例