Univer Skills for AI Agents

Developer skills for Univer aimed at AI agents, providing accurate guidance for integration, extension, and development.

Included Skills

univer-integrate

Helps developers embed Univer (spreadsheets, documents, presentations) into React, Vue 3, Web Component, or Node.js projects, and perform initialization, configuration, and data manipulation.

Coverage:

• Basic integration and plugin registration order
• Complete Facade API reference (FUniver / FWorkbook / FWorksheet / FRange)
• 20+ common task recipes (CSV import/export, number formats, conditional formatting, data validation, filtering, sorting, etc.)
• Custom formula function development
• Permission system (workbook / worksheet / range three-level permissions)
• Multi-unit instance management
• Network layer (HTTP / WebSocket)
• Watermark, Action Recorder, Telemetry, Debugger
• React / Vue / plain HTML / Node.js integration templates

univer-pro-integrate

Helps developers integrate Univer Pro (enterprise edition) into frontend projects, covering Pro-only features that require a license and/or server backend.

Coverage:

• Pro plugin registration (license-first order)
• Real-time collaboration client setup
• XLSX / DOCX import and export via exchange server
• Print configuration and screenshot
• Pivot tables, charts, sparklines, shapes
• Pro Facade API extensions
• License management (client and worker)

univer-node-backend

Helps developers run Univer in Node.js backend environments for headless spreadsheet processing without a browser.

Coverage:

• Node.js-specific plugin registration (no UI plugins)
• RPC Node worker setup (fork() + UniverRPCNodeMainPlugin)
• Batch report generation and JSON import/export
• Server-side formula calculation (inline or worker-based)
• Custom functions in backend context
• Pro features in Node.js (collaboration, pivot, exchange)

univer-plugin-dev

Guides developers in writing custom plugins for Univer, including the command system, UI extensions, and Facade API extensions.

Coverage:

• Plugin lifecycle and dependency injection
• Command system (COMMAND / MUTATION / OPERATION) and Undo/Redo
• Facade extension patterns
• Menus, toolbars, shortcuts, context menus
• Event listening and custom events
• Plugin scaffold script

Installation

Via skills.sh (recommended)

Install both skills with one command:

npx skills add dream-num/univer-sdk-skills

Install a specific skill:

npx skills add dream-num/univer-sdk-skills --skill univer-integrate
npx skills add dream-num/univer-sdk-skills --skill univer-plugin-dev
npx skills add dream-num/univer-sdk-skills --skill univer-pro-integrate
npx skills add dream-num/univer-sdk-skills --skill univer-node-backend

Install globally (available across all projects):

npx skills add dream-num/univer-sdk-skills --global

For project-local installs, skills.sh auto-detects your agent and copies skills to the correct directory.

Manual install

Clone the repository and symlink or copy the skill directories into your agent's skills folder:

git clone https://github.com/dream-num/univer-sdk-skills.git
cd univer-sdk-skills

# Symlink (recommended for development)
ln -s $(pwd)/skills/univer-integrate ~/.codex/skills/univer-integrate
ln -s $(pwd)/skills/univer-plugin-dev ~/.codex/skills/univer-plugin-dev
ln -s $(pwd)/skills/univer-pro-integrate ~/.codex/skills/univer-pro-integrate
ln -s $(pwd)/skills/univer-node-backend ~/.codex/skills/univer-node-backend

# Or copy
# cp -r skills/univer-integrate ~/.codex/skills/
# cp -r skills/univer-plugin-dev ~/.codex/skills/
# cp -r skills/univer-pro-integrate ~/.codex/skills/
# cp -r skills/univer-node-backend ~/.codex/skills/

Common agent skills directories:

Agent	Skills Directory
OpenAI Codex	~/.codex/skills/
Claude Code	~/.claude/skills/
Cursor	~/.cursor/skills/
Gemini CLI	~/.gemini/skills/
Kimi Code CLI	~/.kimi/skills/
Universal (any agent)	~/.agents/skills/

For project-local installation, use the agent-specific directory inside your project root (e.g., .codex/skills/, .claude/skills/, .agents/skills/).

Project Structure

univer-sdk-skills/
├── README.md
├── AGENTS.md
├── scripts/
│   └── validate.py
└── skills/
    ├── univer-integrate/
    │   ├── SKILL.md
    │   ├── agents/openai.yaml
    │   ├── assets/templates/
    │   │   ├── react-vite/
    │   │   ├── vue3-vite/
    │   │   └── plain-html/
    │   └── references/
    │       ├── facade-api-guide.md
    │       ├── common-tasks.md
    │       ├── custom-functions.md
    │       ├── permissions.md
    │       ├── multi-unit-management.md
    │       ├── network-and-others.md
    │       ├── plugin-registry.md
    │       ├── framework-integration.md
    │       └── worker-setup.md
    └── univer-plugin-dev/
        ├── SKILL.md
        ├── agents/openai.yaml
        ├── scripts/scaffold-plugin.ts
        └── references/
            ├── plugin-architecture.md
            ├── command-system.md
            ├── facade-extension.md
            ├── ui-customization.md
            └── event-system.md

Target Audience

• External application developers: Embedding Univer spreadsheets/documents into their own frontend projects
• Pro users: Integrating Univer Pro enterprise features (collaboration, import/export, printing, pivot tables)
• Backend developers: Running Univer in Node.js for headless report generation and server-side data processing
• Plugin developers: Building custom functional extensions for Univer
• AI Agents: Needing accurate understanding of Univer architecture and APIs to assist developers with integration and extension tasks

Version Compatibility

Designed for the open-source version of Univer (@univerjs/* packages). As Univer versions iterate, some APIs may change. It is recommended to use this skill alongside the Univer official documentation.

License

Apache-2.0 (same as the Univer project)