Get started
Choose Runtime, Collaboration, CLI, or Worktree based on your goal and find the canonical Univer documentation.
Univer is an SDK stack for building Office applications in which humans and AI Agents operate the same content. Runtime provides the Web editor, Collaboration SDK provides a self-hosted authoritative collaboration service, and CLI SDK lets Agents read and edit the same Unit. With Worktree, Agent changes become isolated, reviewable, and mergeable.
Choose an entry point by goal
| Goal | Use | Start |
|---|---|---|
| Embed an Office editor | Runtime SDK to display and edit Sheets, Docs, Slides, Boards, and Bases | Runtime quick start |
| Add self-hosted realtime collaboration | Collaboration SDK so multiple Clients can edit one authoritative Unit | Collaboration SDK quick start |
| Let Agents read and edit content | CLI SDK to inspect, edit, and validate Units in Node.js | CLI SDK overview |
| Make Agent changes reviewable | Worktree to isolate changes for human review and merge | Complete Worktree workflow |
How the two documentation sites relate
| Documentation | Canonical scope |
|---|---|
| docs.univer.ai | Runtime SDK, frontend editor features, presets, plugins, and Facade API |
| office.univer.ai | Application architecture, self-hosted Collaboration SDK, CLI SDK, and Agent Worktree |
Both sites describe the same Univer stack. Start in the Runtime documentation when building a Web editor. Return here when adding the new self-hosted collaboration backend or an Agent entry to that application.
How a complete application fits together
An application that supports both human editing and Agent operations typically has Web, CLI, and Server surfaces:
Web provides display, interactive editing, and human review. CLI is the Agent content interface. Server is their shared content authority. These components are composable and can all run locally. See the Univer SDK overview for the complete ownership model.
A practical adoption sequence is:
- Build an editable Web application with the Runtime documentation.
- When multiple users need to synchronize, complete the Collaboration SDK quick start.
- When the application needs an Agent entry, complete CLI content loading and editing.
- Add Worktree when Agent changes require isolation and human review.