Primeros pasos

Crea tu primera aplicación Office con un agente de programación, intégrala y despliégala.

Esta página presenta tres ejemplos trabajados: una hoja de cálculo ligada a las entradas de página, una configuración de colaboración de documentos de dos personas, y un CLI que un agente puede operar. Elige un ejemplo, da su impulso a su agente de codificación, luego siga los pasos de integración y despliegue.

Decide qué construir primero

Oficina SDK cubre Hojas, Docs, Diapositivas, Tablas Relacionales, Canvases y PDFs. Identifique la ruta de integración que coincida con su objetivo de aplicación:

Tu objetivoPor dónde empezarPrimer criterio de éxito
Integrar un editor OfficeInstalación Web SDKCrear contenido, editarlo, guardarlo y volver a abrirlo.
Conectar contenido con la interfaz de negocioAPI FacadeIntroducciones de página y celdas en ambas direcciones, y mostrar los resultados de cálculo real.
Añadir edición colaborativaInicio rápido Server SDKDos sesiones independientes editan el mismo contenido y reciben los cambios de la otra.
Importar, procesar y exportar archivos OfficeConversión de archivosImportar un archivo real, editarlo, exportarlo e inspeccionar el resultado.
Operar contenido desde un agente o CLIOperaciones AI SDKCargar contenido, inspeccionar su estructura, editarlo y verificar la confirmación o salida.
Crear un espacio para personas y agentesWorktree y revisiónMantenga cambios de agente en un borrador aislado para que una persona pueda comparar, revisar y combinarlos.

Combina estas capacidades según sea necesario. Características enumera lo que cada producto soporta; los tres ejemplos siguientes presentan un flujo de trabajo completo de principio a fin.

Empieza con tu agente

Dar a su agente los requisitos y el enlace índice de documentación llms.txt. Usted no necesita copiar toda la documentación SDK en el aviso. Comience desde la plantilla reutilizable a continuación, o pegar uno de los tres ejemplos completos.

Una plantilla de requisitos

Reemplazar <…> con sus propios requisitos. Describir un resultado visible antes de planificar una suite de oficina completa.

text
Crea una aplicación <nombre> ejecutable en local con Univer Office SDK.Lee primero https://docs.univer.ai/es-ES/llms.txt y los ejemplos completos relevantes.Mantén la misma versión en todos los paquetes SDK.Contenido inicial: <pocos datos o un documento listo para editar>.Experiencia principal: <una acción del usuario y su resultado visible inmediato>.Criterios: <dos o tres comprobaciones concretas mediante interacción>.Implementa solo este flujo con el editor nativo Univer y las funciones reales del SDK.Ejecuta la aplicación, verifícala en el navegador y dame un enlace de vista previa.Indica cualquier configuración obligatoria que falte.
Opcional: instalar el Skill para crear aplicaciones

Si su agente de codificación admite Habilidades, instale build-with-univer para que pueda consultar la documentación SDK de forma independiente y determinar cómo Web SDK, Server SDK y AI SDK encajan en su aplicación.

Bash
npx skills add dream-num/skills --skill build-with-univer

Ejecute el comando en el proyecto que su agente ha abierto. Confirme la instalación con npx skills list, luego utilice la plantilla anterior o uno de los ejemplos a continuación. Siga la documentación actual y las versiones SDK que su proyecto realmente utiliza.

Ejemplo 1: una hoja vinculada

Vincula un campo de cantidad con una celda en ambos sentidos y muestra en la página el total calculado por una fórmula.

text
Crea una página de presupuestos ejecutable en local con Univer Office SDK.Lee https://docs.univer.ai/es-ES/llms.txt y los ejemplos completos relevantes.Mantén la misma versión en todos los paquetes SDK.Usa el preset básico de Sheets para insertar una hoja nativa editable.Prepara 2 monitores a 1200 cada uno, 5 teclados a 300 y 3 auriculares a 200.Calcula importes por línea y total mediante fórmulas de la hoja.Al lado, coloca un campo de cantidad de monitores y una tarjeta de total.Vincula el campo con su celda en ambos sentidos. La tarjeta debe leer el resultadoreal de la fórmula; no vuelvas a calcular el presupuesto en el código de la página.Permite guardar en el navegador y restaurar al recargar.Verifica: total inicial 4500 y total 5700 con cantidad 3; editar la celda tambiénactualiza campo y tarjeta; guardar y recargar restaura los cambios.Implementa solo estas funciones, verifica la aplicación en ejecucióny dame un enlace de vista previa.

Pruébalo: Cambiar la cantidad de monitor de 2 a 3, y el total va de 4500 a 5700. Editar la hoja actualiza directamente la página también. Después de guardar y refrescar, los datos se restauran. Continuar con Instalación Web SDK y Facade APIs.

Ejemplo 2: colaboración en documentos

Abra dos sesiones independientes en el mismo documento y verifique que las ediciones aparecen en ambas partes.

text
Crea una demo local de colaboración entre dos personas con Univer Office SDK.Lee https://docs.univer.ai/es-ES/llms.txt y los ejemplos actuales dehttps://github.com/dream-num/univer-collaboration-examples.Usa la misma versión de SDK en frontend y servidor.Coloca los editores nativos de documentos modernos de Alice y Bob en paralelo.Usa entornos y sesiones independientes conectados al servicio real de colaboraciónServer SDK. Sigue el ejemplo oficial para cargar explícitamente el mismo documentocreado en el servidor. Incluye unas frases cortas.Escribir a la izquierda debe aparecer a la derecha, y viceversa, mediante el protocolo SDK.Usa dos usuarios fijos, memoria como almacenamiento y un servicio local para frontend y backend.No añadas inicio de sesión, gestión de archivos ni chat IA. Lee Pro License del entorno;si no existe, conserva el comportamiento y los avisos predeterminados del SDK.Verifica que las ediciones convergen, que el servidor confirma las actualizacionesy que recargar restaura el contenido. Explica que reiniciar el servicio vacía la memoria.Implementa solo estas funciones, verifica la aplicación en ejecucióny dame un enlace de vista previa.

Pruébalo: Escribe una frase a la izquierda, luego sigue escribiendo a la derecha. Ambas partes reciben las actualizaciones. Refresca la página, y el texto permanece. Esta demo almacena todos los datos en memoria, por lo que un servicio lo aclara; conecta una base de datos persistente antes del despliegue. Continuar con el Server SDK colaboración inicio rápido.

Ejemplo 3: crea tu propio you-cli

Construya su propia Oficina de herramientas y prestáselo al agente que ya utiliza. La herramienta debe cubrir la hoja, Doc, Slide, Relational Table, y Canvases, pero comience con un solo Doc para probar el flujo de trabajo "generar → vista previa → revisar a través de la conversación".

text
Crea un you-cli local al proyecto y una vista previa Web con Univer Office SDK.Lee https://docs.univer.ai/es-ES/llms.txt y los ejemplos completos de contenido enhttps://github.com/dream-num/univer-cli-examples.Alinea versiones de frontend, servidor y AI SDK; comprueba los tipos instalados.Admite Sheet, Doc, Slide, Relational Table, Canvases; empieza con Doc.Proporciona ./you-cli create <type> --name <name>, inspect --unit <id>,execute --unit <id> --file <path>, open --unit <id> y --help.Mantén la herramienta en este proyecto y crea instrucciones o un Skill para el agente actual.Devuelve JSON con el unitId, tipo, resultado de confirmación y URL que correspondan.CLI y Web usan el mismo contenido colaborativo real y el editor nativo ya abierto.Espera la confirmación de escritura, vuelve a leer y guarda contenido y catálogo de forma persistente.open devuelve la URL; el agente la abre en el panel de vista previa si el entorno lo admite.Usa el agente actual para entender el lenguaje y lee licencias desde el entorno.Verifica por conversación: crear un informe semanal y abrir la vista previa;añadir riesgo y responsable al mismo unitId y actualizar la vista previa abierta.Recargar y reiniciar deben restaurar el contenido. Ejecuta estas comprobaciones,entrega el enlace y el uso, e inicia solo el servicio de este ejemplo.

Úsalo mediante la conversación

Dar el aviso arriba a su agente de codificación. Una vez que la herramienta existe y el agente ha leído sus instrucciones de proyecto, ingrese en la misma conversación:

text
Usa you-cli para crear un informe semanal con avances, riesgos y próximos pasos.Abre su vista previa Web.

Después de haber revisado el resultado, continúe:

text
Añade al mismo informe el riesgo de retraso de entrega y asigna a Alice como responsable.Actualiza la vista previa que ya está abierta.

El agente reutiliza el unitId del mismo documento. Si el host proporciona un panel de vista previa, la página aparece junto a la conversación; otros entornos utilizan el enlace del navegador devuelto.

Referencia de comandos you-cli

Los siguientes son los comandos locales del proyecto que especifica el prompt. Reemplazar UNIT_ID con el unitId que create devuelve. El agente escribe edit.js utilizando las API de Facade.

AcciónComandoResultado
Crear./you-cli create doc --name "Informe semanal"Crea un documento y devuelve unitId; otros tipos: sheet, slide, base, board.
Inspeccionar./you-cli inspect --unit UNIT_IDLea el contenido real y la revisión actual.
Editar./you-cli execute --unit UNIT_ID --file edit.jsEjecute los cambios, espere el compromiso y devuelva el resultado.
Previsualizar./you-cli open --unit UNIT_IDDevuelve la URL Web del mismo documento para que la abra el agente.

./you-cli --help imprime la interfaz completa. Para las API detrás de estos comandos, vea Operaciones de contenido AI SDK y el Ejemplos de SDK CLI completo.

Conecta el primer flujo a tu aplicación

Web SDK proporciona el tiempo de funcionamiento del contenido compartido. Añadir Server SDK cuando varias personas necesitan editar juntas, y AI SDK cuando un agente necesita operar el contenido. Ver Resumen de la Oficina SDK para el papel de cada paquete.

PasoQué conectar en tu aplicaciónMás información
Insertar el editorMontar un preset, conectar las interacciones de negocios a través de las APIs Facade, guardar instantáneas y disponer de instancias.Integración Web SDK
Conectar el backendReutilizar la identidad existente y los permisos, configurar una base de datos para documentos compartidos, y añadir importación de archivos y exportación según sea necesario.Colaboración, conversión
Conectar un agente existenteExponga operaciones de contenido, cálculo y verificación como herramientas o CLI; agregue Worktree cuando se requiera la revisión.Operaciones AI SDK, Worktree

Arquitectura de la aplicación

Su aplicación y el agente que ya ejecuta puede trabajar en el mismo contenido de Office. La interfaz maneja la interacción, el agente llama herramientas y su backend conserva la propiedad de la identidad, permisos y almacenamiento.

Los nodos azules son suministrados y gestionados por usted: su interfaz, su agente existente, la API de negocio con identidad y permisos, la base de datos y almacenamiento de archivos. Los nodos marcados SDK son las capacidades Univer que integra en la aplicación.

100%

Si sólo incrusta un editor, las instantáneas locales son suficientes; la edición compartida requiere un backend. Retenga el modelo y orquestación que su agente ya utiliza, deje que AI SDK maneje las operaciones de contenido, y agregue Worktree cuando necesite ediciones aisladas, comparación y revisión.

Construye y despliega con Workspace

Univer Workspace combina los tres SDK en un espacio de trabajo de oficina completo. Ejecute los siguientes comandos de la raíz del repositorio Workspace, y siga su README para requisitos.

  1. Desarrollar localmente. Instalar las dependencias, ejecutar pnpm workspace:dev:server y pnpm workspace:dev:web en dos terminales separados, y abrir http://127.0.0.1:5173. El servidor de desarrollo web proxies API y WebSocket solicitudes al backend.
  2. Compilar y ejecutar. Compila solo la aplicación Workspace e inicia su entrada de producción:
Bash
pnpm --filter @univerjs/univer-workspace buildpnpm workspace:start

El archivo coloca los activos Web en dist/public y el código servidor en dist/server; un solo proceso Node.js sirve tanto las páginas estáticas como las APIs.

  1. Preparar el despliegue. Configurar licencias, identidad y directorios de datos. Datos de producto, datos de colaboración y activos cargados, luego reiniciar el servicio y confirmar que los datos son restaurados. Ver Implementación de muelles y arquitectura.

Cuando un solo proceso ya no es suficiente, Orientación para el despliegue de Server SDK explica cómo dividir los servicios.

Explora otros proyectos de código abierto

  • Univer CLI: Crear, editar e inspeccionar el contenido de Office de un agente o un terminal en un espacio de trabajo local, y luego revisar los cambios en el Viewer.
  • DeepSeek Harness: Agregue herramientas de Office, previsualizaciones en vivo, y redacte revisión a una conversación que su agente ya tiene.

Todos los ejemplos recoge los demos del proyecto y sus enlaces de repositorio.

¿Cómo es esta guía?

© 2026 DreamNum Co., Ltd.