
Start with open-source Sheets and Docs, then connect your own application or agent.
🚀 Quick start · 💼 Workspace · 📚 Documentation · ⚖️ Feature comparison · 🌐 Website · 🎮 Showcase · 🔧 API Reference · 📝 Blog
English · Français · Deutsch · Español · 简体中文 · 繁體中文 · 日本語 · 한국어

| Area | Selected capabilities |
|---|---|
| Sheets · Editing and layout | Cell styles, merged cells, in-cell rich text, freeze panes, floating images, and undo/redo. |
| Sheets · Data and calculation | Formulas, defined names, filtering, sorting, data validation, conditional formatting, hyperlinks, comments, and find and replace. |
| Docs | Rich-text editing, paragraph formatting, lists, hyperlinks, comments, and drawing integration. |

| Your goal | Use the open-source foundation | Start here |
|---|---|---|
| Embed Sheets or Docs | Add an editable Office surface to your application or agent product, and connect your data through Facade APIs. | Quick start |
| Process content without an editor | Reuse content plugins, models, commands, and calculation in Node.js for editing, snapshots, and automated tasks. | Headless guide |
| Develop custom features or editors | Reuse the engines, UI components, plugin boundaries, dependency injection, and command/undo systems. Follow existing features to extend Sheets and Docs or develop your own editors. | Open-source architecture |


| Part | How it extends the foundation |
|---|---|
| Open-source Web SDK core · this repository | Open-source models, engines, plugins, UI foundation, and Sheets and Docs capabilities, with corresponding Headless content operations. Use them in commercial applications under Apache-2.0. |
| Commercial Web SDK plugins | Follow the core's Plugin, dependency injection, Command/Mutation, and Facade extension patterns. Add charts, shapes, pivot tables, SmartArt, and other features for the corresponding content types. |
| Server SDK | Extends the same content models and mutation conventions with real-time collaboration, revision history, and Office file conversion. Integrates with your application's identity, permissions, and storage. |
| AI SDK extensions | Reuse Web SDK Headless and Facade capabilities to provide composable Node.js APIs and CLI building blocks for agents to inspect, edit, and check content, with collaboration and Worktree review integrations. |

|
|
|
Agents and editable Office content Keep conversations, spreadsheet editing, and Office content in one workspace. Try Workspace · Workspace source and setup |
Web App × Sheet · Experimental Bind controls to cells: the app writes to the sheet, and sheet changes update the app. Try the sheet-powered app demo |
| Project | What it provides |
|---|---|
| Univer CLI | A local command-line workspace for creating, editing, inspecting, and delivering Office content. |
| Univer Office for DeepSeek Harness | Linked content, result verification, versioned changes, and isolated Worktree collaboration. |
| Univer Office for WorkBuddy | Local Office integration, MCP previews, and draft review. Developer preview. |
| Univer Office for OpenClaw | Tools for creating, reviewing, and delivering Office content. |
| Univer SDK Skills | Instructions that help coding agents integrate the SDK, develop plugins, and implement backend workflows. |
🧩 Web SDK · 🖥️ Server SDK · 🤖 AI SDK · 🔧 API reference · 🎮 Live showcase
Edge |
Firefox |
Chrome |
Safari |
Electron |
|---|---|---|---|---|
>=88 |
>=90 |
>=88 |
>=14.1 |
>=12 |
Univer is compiled with a Chrome 88 target and aims to work with the versions listed above.
### Runtime compatibility - **Polyfills**: Univer relies on `Intl.Segmenter`. Add a polyfill such as `@formatjs/intl-segmenter` if your target browser or runtime does not provide it. - **Build tools**: We recommend Vite, esbuild, or Webpack 5. If your build tool does not support the `exports` field in `package.json` (common in Webpack 4), you may need extra path mapping. - **React**: Univer's view layer is built on React 18, supports React 18 and 19, and provides minimal compatibility support for React 16.9+ and 17. - **Node.js runtime**: Headless Univer supports Node.js `>=18.17.0`. Developing this monorepo requires Node.js `>=22.18`.| Command | Purpose |
|---|---|
pnpm dev |
Start the Sheets and Docs development workbench. |
pnpm build |
Build workspace packages, excluding internal common packages. |
pnpm test |
Run unit tests through Turbo. |
pnpm typecheck |
Run TypeScript checks through Turbo. |
pnpm lint |
Run ESLint. |
pnpm storybook:dev |
Start Storybook for UI component development. |