dream-num/univer

🎯 What Univer Is

Univer is an open‑source Office SDK that lets developers embed spreadsheet, document and presentation editors into their own web or desktop applications. It provides the low‑level building blocks – a canvas‑based renderer, a formula engine, a plugin system and a single Facade API – that work both in the browser and in Node.js (headless mode). In short, it’s a framework for building custom productivity surfaces rather than a finished office suite.

---

🛠️ Core Features (from the README)

Feature	What It Means
Canvas‑based rendering	Handles large workbooks and documents efficiently on a single HTML canvas.
Formula engine	Calculates spreadsheet formulas on the client or server.
Plugin‑first architecture	Every capability (sheets, docs, UI components, commands, etc.) is a plug‑in that can be added, removed or lazy‑loaded.
Preset mode	Curated collections of plug‑ins that give you a ready‑to‑run Sheets/Docs/Slides setup with minimal configuration.
Headless / Node.js support	Same runtime can be used on the server for automation, AI‑agent processing, or batch document generation.
Unified Facade API	One consistent API surface for workbooks, ranges, documents, commands and events, usable from both browser and Node.
Framework adapters	Easy integration with React, Vue or plain Web Components.
Dark‑mode ready UI	Built‑in theming for light and dark appearances.
Extensible UI	Developers can add custom UI components, commands, services, and localisation.

---

🚀 Typical Use‑Cases

• Embedding editors in SaaS products, internal tools or BI dashboards.
• Server‑side processing of spreadsheets/documents for AI agents, automated reporting or data pipelines.
• Building collaborative workspaces (e.g., the open‑source Univer Workspace demo) where multiple users and AI agents edit the same file.
• Creating lightweight, custom office‑like mini‑apps that only need the features you select via plugins.

---

📦 Getting Started (quick glimpse)

1. Choose a mode – Plugin Mode for fine‑grained control, Preset Mode for a quick start, or Headless Mode for Node‑only usage.
2. Install packages (example for preset mode):

   pnpm add @univerjs/presets @univerjs/preset-sheets-core
   

3. Create a container in your HTML:

   <div id="app" style="height:100vh"></div>
   

4. Initialize (preset example):

   import { createUniver, UniverSheetsCorePreset, LocaleType, mergeLocales } from '@univerjs/presets';
   const { univerAPI } = createUniver({
     locale: LocaleType.EN_US,
     locales: { [LocaleType.EN_US]: mergeLocales(UniverPresetSheetsCoreEnUS) },
     presets: [UniverSheetsCorePreset({ container: 'app' })],
   });
   univerAPI.createWorkbook({});
   

---

🤖 AI‑Agent Integration

Univer exposes its model through the Facade API, allowing AI agents to:

• Programmatically read/write cells, ranges, or document sections.
• Verify output via rendered screenshots or layout diagnostics.
• Work in isolated worktrees (drafts) that humans can later review and merge.

The README points to an AI SDK documentation for deeper details.

---

📚 Documentation & Community

• Website & Docs: https://univer.ai / https://docs.univer.ai
• Showcase & Examples: https://github.com/dream-num/univer-workspace and other linked repos.
• Community: Discord, Twitter, Open Collective, and a Trendshift badge.

---

🗂️ License & Commercial Layer

The core SDK and first‑party plugins are open‑source (license file in the repo). A separate commercial offering called Univer Pro adds advanced features such as real‑time collaboration, import/export, charts, pivot tables, and server‑side calculation.

---

📌 Bottom Line

Univer is in‑scope for AI‑related tooling because it provides a headless, programmable office environment that AI agents can manipulate. It’s a genuine, actively maintained open‑source framework for building custom spreadsheet, document, and presentation experiences, with both browser and Node.js runtimes.