Workspace

An open-source workspace built with Univer Office SDK: try it online, self-host it, connect existing agents with Workspace CLI, or work in Desktop.

Univer Workspace turns Univer Office SDK into an open-source Office workspace for people and agents. It brings editable Office content and data-bound Web Apps into Personal and Team Spaces, with sharing, collaboration, versions, and change review. The source repository includes the application, deployment, CLI, and desktop client.

You can deploy Workspace on your own infrastructure, or start with the cloud trial. Your existing agent connects through Workspace CLI; Workspace Desktop brings an agent conversation and the same workspace into a local application. These are ways to work with the same service and files.

Try online · Connect your agent · Self-host · Desktop experience · Source and customization

Start with the cloud Workspace

Open the cloud trial, sign in, and enter your Personal Space or an accessible Team Space. Create or open a document and try direct editing, file organization, and sharing. This is a running Workspace service: you can also connect an agent to it through the CLI below. Use sample data in the trial; its data may be reset.

Workspace Server owns identity, Spaces, permissions, storage, collaboration, and versions. Web is the browser interface for editing and review. A private deployment runs this same Server and Web application.

100%

Connect your existing agent to the cloud Workspace

Install the CLI and discovery Skill where your agent runs. Node.js 22.12 or newer is required; Node.js 24 is recommended. An agent with command execution can use these tools while continuing to provide its own model and conversation. Set the cloud service explicitly so the browser and agent work in the same Workspace:

Bash
npm install --global univer-workspace-cli@latestnpx skills add dream-num/univer-workspace --skill univer-workspace-cli -guvw --versionuvw config set workspace.origin https://space.univer.ai
First connection: sign in once in the browser

Skip this when a valid session already exists. If sign-in is required, run:

Bash
uvw auth login

Open the returned link, sign in, and confirm the code in your browser. Only after the user confirms completion, run:

Bash
uvw auth login --complete

This step is needed when establishing a session. See the Workspace CLI guide for full commands and authentication details.

After the first browser approval, the CLI reuses its session for later tasks. There is no agent-specific login page or authentication integration to build. Give the connected agent a task; open its returned link in Web to inspect the same content and review native Office changes before merging.

Start with a document you can calculate and review

text
Create an English monthly expense Sheet in my Personal Workspace Space with dates, categories, amounts, and five sample rows. Add a total formula and a chart by category.Keep changes in an isolated draft, verify the data, formulas, and rendered result, and give me a preview or review link. Do not merge before I confirm.

Send this to a connected agent or use it in Desktop. The agent creates and verifies; you can request changes, review, and decide whether to merge. You can open the same content in the online edition.

Move the same workflow to your own deployment

The open-source repository includes Server and Web. Follow the deployment guide to build the application and configure your domain, sign-in, persistent storage, and runtime settings. Source development uses Node.js 24 and pnpm 11; production deployment details are maintained in the guide.

Before deployment, prepare these four parts:

PartWhat to configure
ServiceA reachable Workspace URL and the Server + Web application. Desktop and CLI connect to this deployment.
Persistent dataPreserve the product database, collaboration database, and uploaded files together. The default deployment stores them under .data; mount a persistent volume for Docker.
IdentityConfigure sign-in and register the Agent OAuth client with its exact callback URL when connecting Desktop.
SDK licenseSupply VITE_UNIVER_LICENSE when building Web for your deployment domain; configure the license required by the Node.js content runtime separately.

Model credentials belong to the Agent host and are configured separately from Workspace sign-in. See the deployment guide and Agent setup for the current settings.

Point the same CLI at your deployment and authorize an account there. Replace the example address below with your actual service origin:

Bash
uvw config set workspace.origin https://workspace.example.comuvw auth login

Your agent keeps the same tools and Skills; it now operates the files and permissions of your private service. Desktop can connect to that service too. Follow the Agent connection guide for its client registration and callback configuration.

Bring Workspace into a local Desktop client

Workspace Desktop combines Workspace, an agent runtime, Office tools, and content previews in a local client. It gives Office work the conversation-and-preview experience familiar from Codex or Cowork: describe an outcome, inspect the document or Web App beside the conversation, request a revision, and review the result.

Connect Desktop to the cloud Workspace you just tried, your private deployment, or a locally running Workspace service. The model and conversation run through the configured agent host; the connected Workspace remains responsible for files and access. The following real desktop examples show how creation, management, and collaboration connect.

Install and connect · Try a budget review with two native documents

Bring the agent workflow to everyday Office work

Office work needs more than a conversation that returns a downloadable file. People need to keep editing, calculate with real data, work with teammates, and decide which changes to accept. Desktop keeps those steps in the same working environment.

  • Keep context: conversations, files, local references, and Workspace material stay within reach.
  • Native Office content and Web Apps: create, preview, and edit spreadsheets, documents, presentations, Relational Tables, and Canvases, and build interactive pages backed by Office data.
  • See and revise the result: open content beside the conversation, inspect formulas and layout, then ask for a targeted change.
  • Deliver through review: the agent’s native Office changes stay in a Worktree until reviewed and merged into the shared workspace.

From a request to a reviewed deliverable

Generate and revise Office documents and Web Apps in normal conversations, then manage and share them in Space. Native Office changes use Worktree review before merging; HTML publication and binding writes use their own save and authorization flows. Later conversations can reference the same files and data.

100%

What the desktop brings together

CapabilityExperience
Agent sessionsConversations and task context, with provider/model configuration managed locally.
Files and referencesBrowse accessible Spaces; use @ to reference Workspace files or folders and local material.
Content previewsOpen native Office files or Web Apps beside the conversation and inspect content, interactions, and data.
Review and deliveryInspect added, modified, and deleted documents in a Worktree; request revisions, merge, or discard.
Local or hosted WorkspaceConnect to your team’s online service, or run the Workspace service on your own machine.
Space management and collaborationOrganize conversation-created files, manage sharing, and edit the same content with teammates.

Workspace + Agent in practice

The following screenshots show a real macOS Desktop connected to a local Workspace, using fictional launch materials. This integration preview combines an extensible Agent host, the Space capability plugin, and a Univer brand skin; availability follows the project’s releases.

Create and preview in a normal conversation

Describe what you need in a normal conversation and let the Agent create or revise Office documents and Web Apps. Preview the results on the right and continue refining them through conversation. The content is saved in Workspace, where Space brings file management, sharing, and collaboration together.

01 Launch Budget combines budgets, actual spend, forecasts, variance formulas, and totals. Charts compare budget against actual spend and show the variance for each workstream.

The same conversational workflow also produces Web Apps. 06 Launch Dashboard presents budget, actual spend, and variance as KPI cards, charts, and workstream details. HTML View bindings let the page read spreadsheet data, so a team can use an interactive report alongside its Office files. Binding remains experimental.

Manage the results in Space

Conversation results become files that the team can keep using. Space brings Office content and Web Apps together, with product categories, recent files, favorites, and personal or team spaces. The All view below collects materials from Aurora Launch Studio and Team Invitations.

Continue editing and collaborating from Space

Open 01 Launch Budget from Space to continue working in the native spreadsheet editor. Budget lines, formulas, and totals remain editable, with comments, edit history, and sharing available in the same view. Web and Desktop access the same Workspace files; later Agent revisions can stay in a separate Worktree until reviewed.

Worktree and Compare: review before merging

In the Intelligent Workbench, Compare places the official budget beside the Agent’s proposed changes. The draft adds two line items and updates the totals; the change list and highlights help locate the affected cells. Inspect content, formatting, or formulas, then confirm the merge or discard the changes. Worktree keeps the draft separate; Compare makes its differences visible.

Share the document or Web App with the team

Open Share on the dashboard to inspect access and copy its link. In this Team Space, the page inherits member permissions from the Space; Manage Space access opens the place to manage them. Copying a link does not grant additional access.

Install and connect

For an existing extensible agent desktop, the integration route is to install and enable the Space capability plugin, connect from Space, configure the model, and add a brand skin. The screenshots on this page use that composition. The full Workspace Desktop release and the plugin preview have separate delivery paths; use the published release or the repository setup instructions for the version you are installing.

  1. Choose a Desktop installer from GitHub Releases. Desktop releases use agent-v tags; select the matching Windows x64, macOS Apple Silicon, or Linux x64 artifact. Desktop delivery is experimental; availability follows the published releases.

  2. In Settings → Workspace, choose the Workspace service, sign in through the browser, and authorize access. You can connect to a deployed service or follow local setup to run one locally.

  3. Configure a supported provider, model, and credentials in Models settings. Workspace sign-in and model access are separate; see model configuration.

  4. Add an accessible Personal or Team Space, start a conversation, and use @ to reference source material. Try the task below, then open its document preview and changes.

The installer packages the agent application and Office tools. The Workspace service runs separately, locally or remotely; configure model access for the provider you use.

Try a budget review with two native documents

text
In the current Space, create an English Budget Review spreadsheet with eight sample department rows: Department, Budget, Actual, and Variance. Use formulas for Variance and totals, and add a budget-versus-actual chart.Create a short document summarizing the overspend and link it to the spreadsheet. Keep the native Office changes in one Worktree. Verify the values, formulas, and result, open the preview and change review, and wait for my approval before merging.

Follow up with: “Reduce Marketing’s budget by 10% and update the summary.” Inspect the revised values and document changes before accepting the draft.

Build your own Workspace from the repository

The application you have just explored is an Office SDK composition you can adapt. Start from the Workspace repository, reuse the content runtime and collaboration capabilities, and shape the surrounding workflows, Skills, tools, and interface for your own team.

Find the part you want to change

Repository areaResponsibility
apps/workspaceServer, Web, product APIs, and deployment configuration.
apps/cliConnect existing agents to a deployed Workspace.
apps/agentAgent host, connection lifecycle, and the native Desktop shell.
skills/univer-workspace-cliDiscovery Skill installed into your existing agent.
packages/client-coreShared Node-hosted Workspace content operations.
packages/dsh-univer-workspace-pluginOffice tools, native previews, and task guidance for the agent host.
packages/dsh-univer-workspace-skin-pluginWorkspace branding and visual tokens.
packages/workspace-html-viewerHTML View sandbox and binding host for Web Apps.

Skills: help agents understand the workspace and complete tasks

Use these Skills to have your existing agent create and edit Office content and Web Apps in a connected Workspace, then hand off the changes for review. First connect the agent to Workspace; the guidance below operates on the files and permissions of that service.

Skills for your existing agent

The univer-workspace-cli Skill installed in your existing agent is the discovery entry: it explains how to connect, locate the target, and load operational guidance. Full runtime Skills ship with the CLI and match its commands and Facade APIs. Desktop’s built-in capability plugin also provides task guidance and tools.

GuidanceCoverage
coreLocate Spaces and files, work in task drafts, verify content, and hand off for review.
sheet · doc · slide · base · boardSpreadsheets, documents, presentations, Relational Table, and Canvases.
blobUpload, download, and replace original files.
html-viewCreate and manage live HTML pages for interactive Web Apps.
embed · cross-unit-formulaEmbed other content and connect data and formulas across content types.
Bash
uvw skills listuvw skills get coreuvw skills get sheetuvw skills get html-view

Load core first, then the product or topic needed for the task. skills get lists reference paths; use uvw skills read <name> <path> for a selected document or --full to include them together. Existing agents access these capabilities through the CLI, while Desktop integrates its tools and guidance into the conversation workflow.

Skills inside Desktop

Desktop’s capability plugin includes the univer Skill and its references. It teaches the agent how Spaces and documents relate, how to use Office APIs, and how to create, verify, and deliver a Worktree. These instructions accompany executable tools; the agent can look up an API, run it against native content, and inspect the result.

The capability plugin connects file discovery, headless Facade editing, structured inspection, import/export, and Worktree lifecycle tools. This preview prepares drafts for review; publishing uses the deployed application’s review and merge workflow. Your application can add domain Skills, templates, and business tools on the same Office runtime.

The preview plugin includes nine Skills. The common Skill explains discovery, identity, and delivery; product Skills provide API and verification guidance. The agent reads the relevant guidance for the current task.

SkillGuidance
univerSpaces, files, draft lifecycle, and delivery
univer-sheetFormulas, styles, charts, and spreadsheet verification
univer-docDocument structure, paragraphs, and tables
univer-slideSlide authoring and visual layout checks
univer-baseFields, records, and views
univer-boardShapes, connectors, and canvas layout
univer-embedEmbed one Office product inside another
univer-cross-unit-formulaReference and calculate across Units
univer-html-viewBuild and inspect HTML pages bound to Office data

How Office SDK powers Workspace

Workspace connects native editors, agent content operations, and team collaboration to the same documents and permissions. You can build on this open-source application and Office SDK, focusing development on your business workflows, interface, and integrations.

100%

Agents operate on content in Node.js through CLI or Desktop; people view, edit, and review it in Web or Desktop editors. Workspace Server stores shared documents, drafts, and collaboration state. It can run locally, on your servers, or in the cloud.

LayerResponsibility
Web SDKContent models, formulas, public Facade APIs, and native editors.
AI SDKAPI discovery, structured content inspection, and Facade execution on a specified document.
Server SDKCollaboration, revisions, Worktree drafts, and file conversion.
ApplicationWorkspace handles Spaces, files, permissions, sharing, and review. The agent host handles conversations, model calls, and tool orchestration.

CLI and Desktop share a content operations layer. Its runtime pool reuses loaded documents during the host’s lifetime and synchronizes versions before execution. This lets different clients reuse the same editing and submission logic. See runtime reuse.

Visual inspection complements structured checks: screenshots use browser rendering, and automatic layout diagnostics currently detect text overflow and overlap in Slides.

From an agent edit to a reviewed change

For the budget-review example, the agent edits an actual spreadsheet with formulas and styles. The native Office editing path is:

  1. Locate and load. Select the document and Worktree, load its snapshot and changesets, and synchronize to the selected revision. A Unit is one document instance, such as a workbook.
  2. Edit through Facade. The Node.js runtime applies public Facade calls to that Unit. Content changes produce mutations, which are collected into a changeset and submitted to the draft.
  3. Check the result. Read back values and formulas, then inspect rendered output when needed. Continue editing the same draft until the result is ready for review.
  4. Review and merge. A person checks the changes in Compare and decides whether to merge the Worktree into the shared version.

Saving a changeset to a draft is not merging it. Workspace reports a successful write only after submission is confirmed; conflicts or unconfirmed submissions return an error. The Desktop plugin also requires user approval for its merge and discard tool actions. Approval is enforced by the application’s tool workflow.

Connect Web Apps to the same Office data

The launch dashboard uses the same spreadsheet as the budget editor. HTML View renders the page in a sandboxed iframe; the Workspace host resolves accessible source documents and supplies their authorized content engines. Metric cards and charts can subscribe to source data without maintaining another copy of the budget.

For editable bindings, writes require a signed-in identity and edit permission on the source document. The host waits for pending writes and collaboration confirmation when leaving the page, and surfaces save failures. HTML page publishing and binding writes have their own save paths; they do not automatically follow the native Office Worktree merge flow. See experimental data binding and the HTML View host implementation.

Adapt the workflow to your own business

Your goalWhere to start
Industry-specific documents and tasksAdd domain Skills, templates, and tool guidance; retain content and visual verification.
Your own identity, storage, and sharingExtend the Workspace application and its server-side product policies.
Your own agent Office clientCompose the agent host, capability plugin, and brand skin; connect your chosen models and business tools.

Example: add a budget-review Skill

A domain Skill can define your team’s review rules while reusing the existing Office tools:

  • Identify the source workbook, period, and Budget/Actual columns; ask for missing business definitions before editing.
  • Load the spreadsheet guidance, create a Worktree, and use Facade to update formulas and prepare the review document.
  • Verify totals, formula results, and presentation; report the changed files and checks, then hand the draft to a person for review.

Keep business rules and templates in the Skill. Keep access checks, draft persistence, and merge approval in the application. To connect an ERP or CRM, add an application tool that returns the required data, then reuse the same Office editing and review flow. A Skill guides execution; it does not grant access to a file.

Explore the implementation

Desktop build and distribution · Agent application and configuration · All examples

Office Lab

How is this guide?

© 2026 DreamNum Co., Ltd.