Bien démarrer

Ce guide présente trois exemples : liaison avec un tableur, édition collaborative et CLI pour agents. Choisissez un exemple, transmettez son prompt à votre agent de programmation, puis suivez les étapes d’intégration et de déploiement.

Choisir la première application

Office SDK prend en charge Sheets, Docs, Slides, Relational Tables, Canvases et les PDF. Choisissez un parcours d’intégration selon votre objectif.

Ces capacités se combinent. Consultez les fonctionnalités pour la prise en charge par produit ; les trois exemples suivants illustrent un premier parcours complet.

Démarrer avec votre agent

Donnez vos besoins et le lien vers l’index documentaire llms.txt à votre agent de programmation. Inutile de copier toute la documentation SDK. Adaptez le modèle ou collez l’un des trois exemples complets ci-dessous.

Un modèle de demande

Remplacez <…> par vos besoins. Décrivez un résultat visible avant de planifier une suite bureautique complète.

Crée une application <nom> exécutable localement avec Univer Office SDK.Lis d’abord https://docs.univer.ai/fr-FR/llms.txt et les exemples complets associés.Utilise la même version pour tous les packages SDK.Contenu initial : <quelques données ou un document prêt à modifier>.Expérience centrale : <une action et son résultat immédiatement visible>.Critères : <deux ou trois résultats concrets à vérifier par interaction>.Implémente uniquement ce parcours avec l’éditeur natif Univer et le vrai SDK.Lance l’application, vérifie-la dans un navigateur et fournis un lien de prévisualisation.Précise toute configuration obligatoire manquante.

Exemple 1 : un tableur connecté

Reliez un champ de quantité à une cellule dans les deux sens et affichez le total calculé par une formule sur la page.

Crée une page de devis exécutable localement avec Univer Office SDK.Lis https://docs.univer.ai/fr-FR/llms.txt et les exemples complets associés.Utilise la même version pour tous les packages SDK.Intègre une feuille native éditable avec le preset Sheets de base.Prépare 2 écrans à 1200 chacun, 5 claviers à 300 et 3 casques à 200.Calcule les montants de ligne et le total avec les formules du tableur.À côté, place un champ de quantité d’écrans et une carte de total.Relie le champ à sa cellule dans les deux sens. La carte lit le vrai résultatcalculé par la feuille ; ne recalcule pas le devis dans le code de la page.Permets l’enregistrement dans le navigateur et la restauration après actualisation.Vérifie : total initial 4500, puis 5700 avec une quantité de 3 ; modifier la celluleactualise aussi le champ et la carte ; enregistrer puis actualiser restaure les changements.Implémente uniquement ces fonctions, vérifie l’application en cours d’exécutionet fournis un lien de prévisualisation.

À essayer : Passez de 2 à 3 écrans et observez le total passer de 4500 à 5700. Modifiez ensuite la feuille directement pour vérifier la mise à jour de l’interface. Enregistrez et actualisez pour confirmer la restauration. Consultez l’installation Web SDK et les API Facade.

Exemple 2 : la collaboration sur un document

Modifiez le même document depuis deux sessions indépendantes et vérifiez que les changements se synchronisent dans les deux sens.

Crée une démo locale de collaboration à deux avec Univer Office SDK.Lis https://docs.univer.ai/fr-FR/llms.txt et les exemples actuels dehttps://github.com/dream-num/univer-collaboration-examples.Aligne les versions SDK du frontend et du serveur.Place les éditeurs natifs de documents modernes d’Alice et Bob côte à côte.Utilise des environnements et sessions indépendants reliés au vrai service de collaborationServer SDK. Suis l’exemple officiel pour charger explicitement le même document créésur le serveur. Prépare quelques phrases courtes.La saisie à gauche apparaît à droite, et inversement, via le protocole de collaboration SDK.Utilise deux utilisateurs fixes, un stockage en mémoire et un service local pour les deux côtés.N’ajoute ni connexion, ni gestion de fichiers, ni chat IA. Lis la Pro License dansl’environnement ; sans licence, conserve le comportement et les indications par défaut du SDK.Vérifie la convergence après saisie des deux côtés, la validation des mises à jour côté serveuret la restauration après actualisation. Explique que redémarrer le service réinitialise la mémoire.Implémente uniquement ces fonctions, vérifie l’application en cours d’exécutionet fournis un lien de prévisualisation.

À essayer : Saisissez une phrase à gauche, puis poursuivez à droite. Vérifiez la synchronisation dans les deux sens et la conservation du texte après actualisation. Le stockage en mémoire est réinitialisé au redémarrage du service ; utilisez une base persistante pour déployer l’application. Consultez le démarrage rapide de la collaboration Server SDK.

Exemple 3 : créer votre propre you-cli

Donnez à votre agent actuel votre propre outil Office. Prenez en charge Sheet, Doc, Slide, Relational Table et Canvases, en commençant par un Doc pour générer, prévisualiser et réviser par la conversation.

Crée un you-cli local au projet et une prévisualisation Web avec Univer Office SDK.Lis https://docs.univer.ai/fr-FR/llms.txt et les exemples complets de contenu surhttps://github.com/dream-num/univer-cli-examples.Aligne les versions frontend, serveur et AI SDK ; vérifie les types installés.Prends en charge Sheet, Doc, Slide, Relational Table, Canvases ; commence par Doc.Fournis ./you-cli create <type> --name <name>, inspect --unit <id>,execute --unit <id> --file <path>, open --unit <id> et --help.Garde l’outil dans ce projet et fournis des instructions ou un Skill à lire par l’agent actuel.Retourne du JSON avec les informations correspondantes : unitId, type, validation et URL.CLI et Web utilisent le même vrai contenu collaboratif et l’éditeur natif déjà ouvert.Attends la confirmation des écritures, relis-les et conserve contenu et catalogue durablement.open retourne l’URL ; l’agent l’ouvre dans le panneau de prévisualisation si l’hôte le permet.Utilise l’agent actuel pour comprendre le langage et les licences depuis l’environnement.Vérifie par conversation : créer un rapport hebdomadaire, ouvrir son aperçu,puis ajouter un risque et un responsable au même unitId et actualiser l’aperçu ouvert.Actualisation et redémarrage doivent restaurer le contenu. Exécute ces vérifications,fournis le lien et le mode d’emploi, et ne démarre que le service de cet exemple.

Utiliser la conversation

Donnez le prompt ci-dessus à votre agent de programmation. Une fois l’outil construit et ses instructions lues, poursuivez dans la même conversation :

Avec you-cli, crée un rapport hebdomadaire avec progrès, risques et prochaines étapes.Ouvre sa prévisualisation Web.

Après avoir vu le résultat, poursuivez :

Ajoute au même rapport un risque de retard de livraison avec Alice comme responsable.Actualise la prévisualisation déjà ouverte.

L’agent réutilise le unitId du document. Si l’hôte dispose d’un panneau adapté, il affiche la prévisualisation à côté de la conversation ; sinon, il fournit un lien à ouvrir dans le navigateur.

Référence des commandes you-cli

Le prompt définit ces commandes locales au projet. Remplacez UNIT_ID par le unitId retourné par create. L’agent écrit edit.js avec les API Facade.

Utilisez aussi ./you-cli --help. Voir les opérations AI SDK et les CLI SDK Examples complets.

Relier ce premier parcours à votre application

Web SDK fournit le moteur de contenu commun. Ajoutez Server SDK et AI SDK pour l’édition partagée et les opérations d’agent. Leurs rôles sont décrits dans la vue d’ensemble Office SDK.

Architecture de l’application

Votre application et votre agent existant peuvent partager du contenu Office. L’interface gère les interactions, l’agent appelle des outils et votre backend conserve la gestion des identités, autorisations et données.

Les nœuds bleus sont fournis et gérés par vous : interface, agent existant, API métier avec identité et autorisations, base de données et stockage de fichiers. Les autres nœuds portant la mention SDK représentent les capacités Univer intégrées.

Un éditeur intégré peut commencer avec des snapshots locaux ; connectez le backend pour partager l’édition. Gardez le modèle et l’orchestration de votre agent et utilisez AI SDK pour agir sur le contenu. Ajoutez Worktree pour isoler, comparer et réviser les modifications.

Construire et déployer avec Workspace

Univer Workspace illustre les trois SDK dans un espace bureautique complet. Exécutez les commandes à la racine de son dépôt. Suivez le README pour les prérequis.

1. Développer localement. Installez les dépendances puis lancez pnpm workspace:dev:server et pnpm workspace:dev:web dans deux terminaux. Ouvrez http://127.0.0.1:5173. Le serveur Web de développement relaie les requêtes API et WebSocket vers le backend.
2. Construire et lancer. Construisez uniquement l’application Workspace, puis démarrez son point d’entrée de production :

pnpm --filter @univerjs/univer-workspace buildpnpm workspace:start

Le Web est généré dans dist/public, le Server dans dist/server. Un seul processus Node.js sert les pages statiques et les API.

3. Préparer le déploiement. Configurez licences, identités et répertoires de données. Rendez persistants les données métier, les données collaboratives et les fichiers téléversés, puis vérifiez leur restauration après redémarrage. Voir le déploiement Docker et l’architecture.

À mesure que l’application grandit, consultez le guide de déploiement Server SDK pour séparer les services.

Explorer d’autres projets open source

• Univer CLI : créer, modifier et inspecter du contenu Office dans un espace local via un agent ou un terminal, puis réviser les changements dans le Viewer.
• DeepSeek Harness : ajouter des outils Office, une prévisualisation en direct et la révision de brouillons à une conversation d’agent existante.

Consultez tous les exemples pour les démonstrations et liens des dépôts.