# Get started

> Choose Runtime, Collaboration, CLI, or Worktree based on your goal and find the canonical Univer documentation.

- Human documentation: [https://office.univer.ai/getting-started](https://office.univer.ai/getting-started)

- Agent Markdown: [https://office.univer.ai/getting-started.md](https://office.univer.ai/getting-started.md)

- Language: `en`

- Source file: `content/docs/getting-started.mdx`

- Upstream source: [https://github.com/dream-num/office.univer.ai/blob/main/content/docs/getting-started.mdx](https://github.com/dream-num/office.univer.ai/blob/main/content/docs/getting-started.mdx)

---

**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](https://docs.univer.ai/guides/docs/getting-started/quickstart)   |
| Add self-hosted realtime collaboration | Collaboration SDK so multiple Clients can edit one authoritative Unit   | [Collaboration SDK quick start](https://office.univer.ai/collaboration/quick-start.md) |
| Let Agents read and edit content       | CLI SDK to inspect, edit, and validate Units in Node.js                 | [CLI SDK overview](https://office.univer.ai/cli/overview.md)                           |
| Make Agent changes reviewable          | Worktree to isolate changes for human review and merge                  | [Complete Worktree workflow](https://office.univer.ai/cli/worktree.md)                 |

## How the two documentation sites relate

| Documentation                                 | Canonical scope                                                                      |
| --------------------------------------------- | ------------------------------------------------------------------------------------ |
| [docs.univer.ai](https://docs.univer.ai/)     | Runtime SDK, frontend editor features, presets, plugins, and Facade API              |
| [office.univer.ai](https://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.

> **Do not start a new integration with Legacy Univer Server**
>
> Search results on `docs.univer.ai` may still surface older Univer Server, Universer, or Server API
> pages. They are not the Collaboration backend path for new applications. New applications use the
> self-hosted **Univer Collaboration SDK** documented here; the legacy integration is deprecated and
> unsupported.

## How a complete application fits together

An application that supports both human editing and Agent operations typically has Web, CLI, and
Server surfaces:

```mermaid
flowchart LR
    Human([Human user]) --> Web["Web<br/>Runtime SDK"]
    Agent([AI Agent]) --> CLI["CLI<br/>CLI SDK"]
    Web --> Server["Server<br/>Collaboration SDK + application code"]
    CLI --> Server
    Server --> Storage[(Product and collaboration storage)]
```

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](https://office.univer.ai/overview/overview.md) for the complete ownership model.

A practical adoption sequence is:

1. Build an editable Web application with the Runtime documentation.
2. When multiple users need to synchronize, complete the [Collaboration SDK quick start](https://office.univer.ai/collaboration/quick-start.md).
3. When the application needs an Agent entry, complete [CLI content loading and editing](https://office.univer.ai/cli/content-operations.md).
4. Add [Worktree](https://office.univer.ai/cli/worktree.md) when Agent changes require isolation and human review.

## Example collections

### Teaching examples

> **Collaboration Examples**
>
> Explore minimal Web + Server compositions and collaboration capabilities. Read the [examples
> index](https://office.univer.ai/collaboration/examples.md&#x29;, or **[view the complete repository on
> GitHub](https://github.com/dream-num/univer-collaboration-examples)**.

> **CLI Examples**
>
> Explore Agent content operations, file exchange, visual inspection, and Worktree. Read the
> [examples index](https://office.univer.ai/cli/examples.md&#x29;, or **[view the complete repository on
> GitHub](https://github.com/dream-num/univer-cli-examples)**.

### Application examples

> **univer-cli**
>
> `univer-cli` is a local-first Office CLI for Agents. Agents can read, modify, and inspect content
> before delivering results through local files, collaborative Units, or Worktrees. **[View the
> repository on GitHub](https://github.com/dream-num/univer-cli)**.

> **univer-workspace**
>
> `univer-workspace` is an Office workspace for knowledge management and team collaboration. Humans
> organize, co-edit, and review content while Agents participate through CLI and Worktree. **[View
> the repository on GitHub](https://github.com/dream-num/univer-workspace)**.

> **dsh-univer-office**
>
> `dsh-univer-office` is the Univer Office plugin for DeepSeek Harness. Users ask an Agent to create
> or edit Office content, then preview, revise, merge, or discard the result in the conversation.
> **[View the repository on GitHub](https://github.com/dream-num/dsh-univer-office)**.