Give agents a local command-line workspace for creating, editing, inspecting, and delivering spreadsheets, documents, presentations, multidimensional tables, and canvases.
English · 简体中文
Univer CLI is a local-first Office CLI for agents. Install the official univer-cli Skill, describe the result you want, and let the agent create or edit Sheet, Doc, Slide, Base, and Board content. It can also work with existing Excel, Word, and PowerPoint files.
Changes stay in an isolated Worktree while the agent inspects the content, edits it through the Univer Facade, and verifies the stored model and rendered result. When the task is ready, the agent returns a local Viewer URL so you can review the result and decide whether to merge, revise, or discard it.
Copy the entire prompt below into the agent you use:
Install the Univer CLI Skill:
npx skills add dream-num/skills -s univer-cli -g
Download the official sample to ./hello.univer:
https://univer.ai/cli-assets/hello.univer
Open ./hello.univer with Univer CLI, then show me the local Viewer link and
what I can explore.
If you need help, visit:
https://discord.gg/nThHPupraR
- Analyze and build spreadsheets — read or create data, clean fields, write formulas, apply formatting and validation, and add tables, charts, pivots, filters, sparklines, conditional formatting, and images.
- Write and lay out documents — create paragraphs, rich text, lists, tasks, tables, images, charts, headers, footers, pagination, and page layouts.
- Create and revise presentations — build a deck from an outline, edit selected pages, add text, shapes, images, tables, charts, and transitions, and detect off-page, overflowing, or overlapping text.
- Build multidimensional tables — create Base tables, fields, records, views, formulas, filters, sorting, grouping, and Sheet-backed references.
- Draw editable canvases — create Board shapes, text, connectors, images, native charts, and diagrams, with connector and layout analysis.
- Compose several content types — keep Sheet, Doc, Slide, Base, and Board Units in one
.univerfile and reference content across Units. - Work with Office files — import Excel, CSV, TSV, Word, and PowerPoint files, then export supported content to standard Office formats.
- Review agent changes safely — keep every write in an isolated draft until the user explicitly decides to merge or discard it.
Use univer-cli to create a payroll spreadsheet with formulas, totals, validation,
conditional formatting, and a summary chart. Return a Viewer URL for review.
Use univer-cli to turn brief.md into a six-slide lesson deck about bubble sort.
Check every page for overflow and overlap before marking the Worktree ready.
Use univer-cli to create a formal weekly project report with an executive summary,
a risk table, next week's plan, headers, and footers, then export it as DOCX.
Use univer-cli to create a customer-tracking Base with company, contact, stage,
expected value, and next action fields, plus a view grouped by stage.
Use univer-cli to create a sales Sheet and a summary Slide in the same .univer file,
with the Slide chart reading data from the Sheet.
| Content | Create and edit | Verify and review | Import | Export |
|---|---|---|---|---|
| Sheet | Cells, formulas, styles, tables, charts, pivots, filters, validation, images, and more | Structured workbook/range inspection and screenshots | .xls .xlsx .xlsm .csv .tsv |
.xlsx .csv .tsv |
| Doc | Paragraphs, rich text, lists, tasks, tables, images, charts, headers, footers, and pagination | Document/paragraph readback and page screenshots | .doc .docx |
.docx |
| Slide | Pages, text, shapes, images, tables, charts, SVG layouts, and transitions | Structure inspection, layout lint, and page/contact-sheet screenshots | .ppt .pptx |
.pptx |
| Base | Tables, fields, records, views, formulas, filters, sorting, and grouping | Structured data checks and workbench screenshots | .xls .xlsx .xlsm .csv .tsv |
.xlsx .csv .tsv |
| Board | Shapes, text, connectors, images, native charts, and routing | Element/connector analysis and overview/region/element screenshots | — | — |
Every content type supports isolated draft editing, review, revision, merge, and discard. Board file import and export are not currently supported.
- The discovery Skill checks that Univer CLI is installed, current, and ready.
- The agent loads the core Skill and the matching Sheet, Doc, Slide, Base, or Board Skill from the installed CLI.
- The agent imports or creates a
.univerfile and opens an isolated draft Worktree. - It inspects the target Unit, makes the requested changes, and reads the stored model back.
- It captures screenshots or runs layout lint when appearance matters.
- It marks the Worktree
readyand returns a local Viewer URL. - The user reviews the result and explicitly chooses merge, reopen, or discard.
The operational Skills ship with Univer CLI so their commands and Facade guidance match the installed application version.
The Skill selects these capabilities automatically. Most users do not need to call them manually.
| Commands | Purpose |
|---|---|
new, import |
Create a .univer file or import Office content |
status, unit |
Inspect file status and manage Sheet, Doc, Slide, Base, or Board Units |
worktree |
Create, prepare, reopen, merge, or discard isolated changes |
inspect |
Read Workbook, Worksheet, Range, Document, Paragraph, Presentation, or Slide data |
execute |
Read or edit content through trusted Univer Facade code |
screenshot, lint |
Render content and diagnose Slide layout issues |
compile-svg, compile-typst |
Turn SVG or Typst sources into editable Univer content |
export, open |
Export Office files or return a local Viewer URL |
api, resources, skills |
Find Facade APIs, visual resources, and operational guidance |
config, doctor, update, daemon, optimize |
Configure, diagnose, update, run, and maintain the local application |
See the complete CLI reference for command options, selectors, environment variables, machine output, and process behavior.
- An agent that supports Agent Skills, plus Node.js 24.0 or later and npm/npx.
- Screenshot, Slide layout lint, and browser text measurement require Chrome, Chromium, or Edge. The agent can prepare the browser through
univer screenshot setup. executeruns trusted JavaScript and is not a sandbox for untrusted code..univerfiles, the Gateway, Viewer, daemon, runtime workers, and browser cache stay on the local machine. Explicit HTTP imports, resource downloads, and update checks can access the network.- Board supports structural and visual verification but does not currently support file import or export.
Univer CLI is built on the Univer SDK. This repository assembles the SDK into a local Office CLI for agents and implements the application-specific capabilities for .univer files, the Gateway, Viewer, process management, and safe data upgrades.
apps/cli is the only public application, and univer is its only program and binary. Private packages/* projects support the application and are not parallel products.
A .univer file uses SQLite to store Units, revisions, Worktrees, local resources, and a rebuildable History index. Supported earlier formats are upgraded only after read-only identification, a byte-for-byte backup, independent candidate verification, and atomic replacement. A failed upgrade never overwrites the source.
The bundled Univer runtime development license is a localhost application credential authorized for redistribution with this application. It rotates every 90 days and is separate from the repository software license.
The project requires Node.js 24.0 or later and the pnpm version declared in package.json.
git clone https://github.com/dream-num/univer-cli.git
cd univer-cli
pnpm install --frozen-lockfile
pnpm link:cli
pnpm checkStop the daemon before unlinking a local build:
univer daemon stop
pnpm unlink:cliEvery Univer SDK dependency (@univer-cli/*, @univerjs/*, @univerjs-pro/*) moves as one exact version cohort, while @univerjs/icons, @univerjs-pro/cli-assets, @univerjs-pro/engine-formula-rust-binding, and @univerjs-pro/exchange-node-binding keep their own release chains. Upgrade the cohort with:
pnpm update:sdk --sdk_version <exact-sdk-version>Commit all affected manifests together with pnpm-lock.yaml; updating only part of the cohort by hand is not allowed.
Apache-2.0. Univer Pro SDK packages, runtime credentials, native bindings, and other third-party components retain their own terms.