# Univer Office Documentation

> English developer documentation for Univer Office Suite architecture, collaboration, and command-line workflows.

Each link points to a clean Markdown representation. Remove the `.md` suffix to open the corresponding human-readable page.

## Required workflow before application development

Do not begin development after reading only this index, a single documentation page, or isolated code snippets. Before writing code, complete the following steps:

1. **Read the relevant documentation.** Read the relevant pages in full, including linked prerequisites and architecture guidance. Understand the recommended workflow, module responsibilities, and required packages.
2. **Read the complete examples implementation.** Clone the relevant examples repository unless an up-to-date local checkout already exists. Choose the closest example and read its README and complete source, not only its entry points or snippets shown in the documentation. Follow the actual execution flow through dependencies, configuration, entry points, module registration, shared code, data flow, and resource disposal. Continue into referenced files as needed until you understand how the complete example works.
3. **Read the relevant package READMEs.** Identify the SDK packages used by the application, then read the SDK's root README and every relevant package README. Confirm their responsibilities, public APIs, initialization, configuration, resource disposal, and version requirements. If the application uses a version different from the repository's default branch, use the installed package's types or source as the reference.
4. **Implement only after completing this research.** Use the documentation, the examples' complete assembly, and the package READMEs together. Do not invent APIs.

Relevant repositories:

- Collaboration: [examples repository](https://github.com/dream-num/univer-collaboration-examples) and [SDK repository](https://github.com/dream-num/univer-collaboration-sdk).
- CLI: [examples repository](https://github.com/dream-num/univer-cli-examples) and [SDK repository](https://github.com/dream-num/univer-cli-sdk).

## Documentation

- [Get started](https://office.univer.ai/getting-started.md): Choose Runtime, Collaboration, CLI, or Worktree based on your goal and find the canonical Univer documentation.
- [Univer SDK overview](https://office.univer.ai/overview/overview.md): Understand the Univer SDK family and how its Runtime, CLI, and Collaboration SDKs are used to build applications.
- [Collaboration SDK overview](https://office.univer.ai/collaboration/overview.md): Understand what the Univer Collaboration SDK solves, how its modules compose, its extension points, and the product boundaries your application retains.
- [Quick start](https://office.univer.ai/collaboration/quick-start.md): Run two-browser collaboration, then move the minimal Client, Transport, Endpoint, Service, and Adapter composition into your application.
- [Module boundaries and relationships](https://office.univer.ai/collaboration/modules.md): Understand the responsibilities, data flow, and assembly of the Collaboration Client, Transport, Endpoint, Service, and Database Adapter.
- [Middleware and Events](https://office.univer.ai/collaboration/middleware-and-events.md): Extend the Transport, Endpoint, Service, and collaboration extension modules with general-purpose Middleware and Events.
- [Identity and authorization](https://office.univer.ai/collaboration/identity-and-authorization.md): Connect an existing authentication and authorization system through Transport, Endpoint, and Service Middleware.
- [Database Adapters](https://office.univer.ai/collaboration/database-adapters.md): Understand the collaboration persistence contract and choose between Memory, SQLite, and custom Database Adapters.
- [Collaboration Extension Modules](https://office.univer.ai/collaboration/extensions.md): Understand how History, Thread Comment, Worktree, and server-side Office Exchange extend core collaboration.
- [Package Overview](https://office.univer.ai/collaboration/packages.md): Understand the public Collaboration SDK packages for Core, History, Thread Comment, Worktree, and Office Exchange.
- [Examples](https://office.univer.ai/collaboration/examples.md): Run Collaboration SDK examples by capability and open each example's guide, Server entry point, and Web entry point.
- [CLI SDK overview](https://office.univer.ai/cli/overview.md): Understand how Univer CLI SDK adds a Node.js CLI and agent entry point to a Univer application.
- [Document loading and content operations](https://office.univer.ai/cli/content-operations.md): Learn the minimum agent content-operation flow and assemble Collaboration Runtime, Inspection, API Reference, and Content Execution.
- [Office file import and export](https://office.univer.ai/cli/file-exchange.md): Use Univer Pro Exchange to import and export content between Office files and collaborative Units.
- [Visual inspection](https://office.univer.ai/cli/visual-inspection.md): Use Render Runtime, Screenshot, and Layout Lint to give agents rendered visual information.
- [Worktree: agent editing and human review](https://office.univer.ai/cli/worktree.md): Let an agent edit and inspect a Unit in an isolated Worktree draft, then let a human review and merge it through Web.
- [Runtime reuse and Daemon](https://office.univer.ai/cli/runtime-architecture.md): Start with the Runtime lifecycle of a single CLI command, then learn how a daemon owns a Worker Runtime pool and reuses loaded Units across calls.
- [Package catalog](https://office.univer.ai/cli/packages.md): Select every Univer CLI SDK package by content, collaboration, compilation, rendering, process, and application task.
- [Examples](https://office.univer.ai/cli/examples.md): Learn Univer CLI SDK content operations, Office file import and export, visual inspection, and Worktree in order.
- [SDK environment and version requirements](https://office.univer.ai/requirements.md): Runtime and version alignment requirements for Univer Collaboration SDK and CLI SDK.