Bien démarrer

Créez une première application Office avec un agent de programmation, puis intégrez-la et déployez-la.

Cette page présente trois exemples travaillés : un tableur lié aux entrées de page, une configuration de collaboration de deux personnes et un CLI qu'un agent peut opérer. Choisissez un exemple, donnez son appel à votre agent de codage, puis suivez les étapes d'intégration et de déploiement.

Choisir la première application

Bureau SDK couvre les feuilles, les docs, les diapositives, les tableaux relationnels, les toiles et les PDF. Identifiez le chemin d'intégration qui correspond à votre objectif d'application:

Votre objectifPoint de départPremier critère de réussite
Intégrer un éditeur OfficeInstallation Web SDKCréer du contenu, le modifier, l’enregistrer et le rouvrir.
Relier le contenu à une interface métierAPI FacadeBind pages entrées et cellules dans les deux directions, et afficher les résultats réels de calcul.
Ajouter l’édition collaborativeDémarrage rapide Server SDKDeux sessions indépendantes modifient le même contenu et reçoivent leurs changements respectifs.
Importer, traiter et exporter des fichiers OfficeConversion de fichiersImporter un vrai fichier, le modifier, l’exporter et vérifier le résultat.
Faire agir un agent ou une CLI sur le contenuOpérations AI SDKCharger le contenu, inspecter sa structure, le modifier et vérifier la validation ou la sortie.
Créer un espace pour les personnes et les agentsWorktree et révisionConservez les changements d'agent dans une ébauche isolée pour qu'une personne puisse les comparer, les examiner et les fusionner.

Combinez ces capacités au besoin. Caractéristiques énumère ce que chaque produit supporte; les trois exemples ci-dessous présentent un flux de travail complet du début à la fin.

Démarrer avec votre agent

Donnez à votre agent les exigences et le lien d'index de documentation Ilms.txt. Vous n'avez pas besoin de copier la documentation SDK entière dans l'invite. Commencez à partir du modèle réutilisable ci-dessous, ou collez l'un des trois exemples complets.

Un modèle de demande

Remplacer <…> par vos propres exigences. Décrivez un résultat visible avant de planifier une suite de bureau entière.

text
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.
Facultatif : installer le Skill de création d’applications

Si votre agent de codage prend en charge Skills, installez build-with-univer afin qu'il puisse consulter la documentation SDK de manière indépendante et déterminer comment Web SDK, Server SDK et AI SDK s'intègrent dans votre application.

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

Exécutez la commande dans le projet que votre agent a ouvert. Confirmez l'installation avec npx skills list, puis utilisez le modèle ci-dessus ou l'un des exemples ci-dessous. Suivez la documentation actuelle et les versions SDK que votre projet utilise réellement.

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.

text
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.

Essaie. Changez la quantité de moniteur de 2 à 3, et le total passe de 4500 à 5700. Modifier la feuille met à jour directement la page. Après avoir enregistré et mis à jour, les données sont restaurées. Continuez avec Installation Web SDK et API Façade.

Exemple 2 : la collaboration sur un document

Ouvrez deux sessions indépendantes sur le même document et vérifiez que les modifications apparaissent des deux côtés.

text
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.

Essaie. Tapez une phrase sur la gauche, puis continuez à taper sur la droite. Les deux côtés reçoivent les mises à jour. Rafraîchir la page et le texte reste. Cette démo stocke toutes les données en mémoire, de sorte qu'un service redémarre l'effacement; connectez une base de données persistante avant le déploiement. Continuez avec le Début rapide de la collaboration Server SDK.

Exemple 3 : créer votre propre you-cli

Construisez votre propre outil Office et fournissez-le à l'agent que vous utilisez déjà. L'outil devrait couvrir Feuille, Doc, Diapositive, Table Relationnelle et Toiles, mais commencez par un seul Doc pour essayer le workflow "générer → prévisualiser → réviser par conversation".

text
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 l'invite ci-dessus à votre agent de codage. Une fois que l'outil existe et que l'agent a lu ses instructions de projet, entrez ce qui suit dans la même conversation :

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

Après avoir examiné le résultat, continuez comme suit :

text
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 même document. Si l'hôte fournit un panneau de prévisualisation, la page apparaît à côté de la conversation; d'autres environnements utilisent le lien du navigateur retourné.

Référence des commandes you-cli

Ce qui suit sont les commandes project-local que l'invite spécifie. Remplacez UNIT_ID par unitId que create renvoie. L'agent écrit edit.js à l'aide des API Facade.

ActionCommandeRésultat
Créer./you-cli create doc --name "Rapport hebdomadaire"Crée un document et retourne unitId ; autres types : sheet, slide, base, board.
Inspecter./you-cli inspect --unit UNIT_IDLisez le contenu réel et la révision actuelle.
Modifier./you-cli execute --unit UNIT_ID --file edit.jsExécutez les modifications, attendez le commit et retournez le résultat.
Prévisualiser./you-cli open --unit UNIT_IDRetourne l’URL Web du même document pour l’agent.

./you-cli --help imprime l'interface complète. Pour les API derrière ces commandes, voir Opérations de contenu AI SDK et Exemples de SDK CLI complet.

Relier ce premier parcours à votre application

Web SDK fournit le contenu partagé runtime. Ajoutez Server SDK lorsque plusieurs personnes ont besoin de modifier ensemble, et AI SDK lorsqu'un agent a besoin d'exploiter du contenu. Voir Aperçu du SDK de bureau pour le rôle de chaque paquet.

ÉtapeÀ connecter dans votre applicationPour continuer
Intégrer l’éditeurMontez un préréglage, connectez les interactions d'affaires à travers les API Facade, enregistrez les instantanés et éliminez les instances.Intégration Web SDK
Connecter le backendRéutiliser l'identité et les permissions existantes, configurer une base de données pour les documents partagés, et ajouter l'importation et l'exportation de fichiers au besoin.Collaboration, conversion
Connecter un agent existantExposer les opérations de contenu, le calcul et la vérification en tant qu'outils ou CLI; ajouter Worktree lorsque l'examen est nécessaire.Opérations AI SDK, Worktree

Architecture de l’application

Votre application et l'agent que vous exécutez déjà peuvent travailler sur le même contenu Office. L'interface gère l'interaction, les outils d'appel de l'agent, et votre moteur conserve la propriété de l'identité, des permissions et du stockage.

Les nœuds bleus sont fournis et gérés par vous : votre interface, votre agent existant, l'API d'affaires avec identité et permissions, la base de données et le stockage de fichiers. Les nœuds marqués SDK sont des capacités Univer que vous intégrez dans l'application.

100%

Si vous intégrez seulement un éditeur, les instantanés locaux sont suffisants; l'édition partagée nécessite un moteur de lecture. Conserver le modèle et l'orchestration que votre agent utilise déjà, laisser AI SDK gérer les opérations de contenu, et ajouter Worktree lorsque vous avez besoin de modifications isolées, de comparaison et de révision.

Construire et déployer avec Workspace

Univer Espace de travail combine les trois SDK dans un espace de travail complet. Exécutez les commandes suivantes depuis la racine du dépôt Workspace, et suivez son RÉPERTOIRE pour les conditions préalables.

  1. Développer localement. Installez les dépendances, lancez pnpm workspace:dev:server et pnpm workspace:dev:web dans deux terminaux séparés, et ouvrez http://127.0.0.1:5173. Le serveur de développement Web effectue des requêtes API et WebSocket vers le moteur.
  2. Construire et lancer. Construisez uniquement l’application Workspace, puis démarrez son point d’entrée de production :
Bash
pnpm --filter @univerjs/univer-workspace buildpnpm workspace:start

La construction place les actifs Web en dist/public et le code serveur en dist/server; un seul processus Node.js sert à la fois les pages statiques et les API.

  1. Préparez le déploiement. Configurer les licences, l'identité et les répertoires de données. Persistez les données de produit, les données de collaboration et les actifs téléchargés, puis redémarrez le service et confirmez que les données sont restaurées. Voir Déploiement de Docker et les architecture.

Lorsqu'un seul processus n'est plus suffisant, Guide de déploiement Server SDK explique comment diviser les services.

Explorer d’autres projets open source

  • CLI Univer : Créez, modifiez et inspectez le contenu de l'Office depuis un agent ou un terminal dans un espace de travail local, puis examinez les modifications dans le Visionneur.
  • Harnais de recherche profonde: Ajouter des outils Office, des prévisualisations en direct et une révision préliminaire à une conversation que votre agent a déjà.

Tous les exemples collecte les démos du projet et leurs liens de dépôt.

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.