Interface de ligne de commande de Microsoft 365 Agents Toolkit

Importante

Le SDK TeamsFx n’est plus pris en charge par Microsoft pour la création d’extensions Microsoft 365 Copilot, d’agents Microsoft 365 ou de scénarios d’applications Teams modernes. Les nouveaux développements ne doivent pas utiliser TeamsFx. Le Kit de développement logiciel (SDK) est actuellement en mode dépréciation et bénéficiera d’un support communautaire uniquement sur GitHub jusqu’en septembre 2026.

Pour tout développement de nouveaux agents et applications Teams, utilisez le SDK Teams et l’interface de ligne de commande Teams pour les développeurs.

L’interface de ligne de commande Microsoft 365 Agents Toolkit (Agents Toolkit CLI) est une interface de ligne de commande texte qui permet de générer des modèles automatiques, de valider et de déployer des applications pour Microsoft 365 à partir du terminal ou d’un processus CI/CD. Pour plus d’informations, consultez code source et package npm.

Que vous préfériez les opérations de développement centrées sur le clavier ou que vous automatisiez votre pipeline CI/CD, Agents Toolkit CLI offre les mêmes fonctionnalités que les extensions de l’IDE. Il fournit les fonctionnalités suivantes pour faciliter le développement d’agents ou d’applications pour Microsoft 365 Copilot, Microsoft Teams et Microsoft 365 :

  • Collaboration : invitez d’autres développeurs à collaborer sur votre projet Agents Toolkit pour déboguer et déployer.
  • Création d’agent/application : générez un agent ou une application à l’aide des modèles et exemples disponibles.
  • Aperçu de l’agent/de l’application : chargez et affichez un aperçu de votre agent ou application dans Teams, Outlook et l’application Microsoft 365.
  • Approvisionnement et déploiement des ressources : approvisionnez les ressources cloud nécessaires et déployez votre application dans Azure.
  • Validation, empaquetage et publication : validez, empaquetez et publiez votre agent ou application à l’aide de commandes CLI.
  • Gestion de l’environnement : gérez plusieurs environnements, les applications Microsoft Entra et l’inscription des applications Teams.

Prise en main

Installez @microsoft/m365agentstoolkit-cli à partir de npm et exécutez atk -h pour vérifier toutes les commandes disponibles :

  npm install -g @microsoft/m365agentstoolkit-cli
  atk -h

La capture d’écran montre l’installation du package npm.

Commandes prises en charge

Le tableau suivant répertorie les commandes prises en charge pour aider les développeurs à créer et à gérer des agents ou des applications :

Command Description
atk doctor Vérificateur des composants requis pour la création de Microsoft 365 Apps.
atk new Créer une application Microsoft 365.
atk add Ajoutez des fonctionnalités à votre application Microsoft 365.
atk auth Gérer les comptes Microsoft 365 et Azure.
atk entra-app Gérez l’application Microsoft Entra dans l’application active.
atk env Gérer des environnements.
atk help Afficher l’aide de l’interface de ligne de commande Microsoft 365 Agents Toolkit.
atk install Chargez un package d’application donné dans Microsoft 365.
atk launchinfo Obtenez des informations sur le lancement d’une application Microsoft 365 acquise.
atk list Répertorier les modèles et exemples d’application Microsoft 365 disponibles.
atk provision Exécuter l’étape d’approvisionnement dans m365agents.yml ou m365agents.local.yml.
atk deploy Exécutez l’étape de déploiement dans m365agents.yml ou m365agents.local.yml.
atk package Construisez votre application Microsoft 365 dans un package pour la publication.
atk validate Validez l’application Microsoft 365 à l’aide d’un schéma de manifeste, de règles de validation ou de cas de test.
atk publish Exécuter la phase de publication dans m365agents.yml.
atk preview Affichez un aperçu de l’application actuelle.
atk update Mettez à jour le manifeste de l’application Microsoft 365 vers le portail des développeurs.
atk upgrade Mettez à niveau le projet pour qu’il fonctionne avec la dernière version de Microsoft 365 Agents Toolkit.
atk collaborator Vérifiez, accordez et répertoriez les autorisations pour qui peut accéder et gérer l’application Microsoft 365 et l’application Microsoft Entra.
atk uninstall Nettoyez les ressources associées à l’ID de manifeste, à l’ID de titre ou à un environnement.

La capture d’écran montre la liste des commandes disponibles.

Options globales

Les options globales que vous pouvez utiliser avec chaque commande sont les suivantes :

Options Description
--version -v Afficher la version CLI de Microsoft 365 Agents Toolkit.
--help -h Afficher l’aide de l’interface de ligne de commande Microsoft 365 Agents Toolkit.
--interactive -i Exécutez la commande en mode interactif. La valeur par défaut est True.
--debug Imprimer les informations de débogage. La valeur par défaut est false.
--verbose Imprimer les informations de diagnostic. La valeur par défaut est false.
--telemetry Active la télémétrie. La valeur par défaut est True.

La capture d’écran montre la liste des options globales.

Mode interactif

Les commandes ont différents modes interactifs par défaut. Certaines commandes sont interactives par défaut et d’autres non. Pour déterminer le mode interactif par défaut d’une commande, utilisez l’option -h associée à la commande spécifique.

atk doctor

La atk doctor commande vérifie les conditions préalables nécessaires à la création de Microsoft 365 Apps.

atk new

La atk new commande fonctionne en mode interactif par défaut et fournit des instructions pour créer une nouvelle application Microsoft 365. Pour travailler atk new en mode non interactif, définissez l’indicateur --interactive sur false.

atk new
atk new -i false
Command Description
atk new sample Créer une application à partir d’un exemple existant.
atk list samples Affiche une liste de tous les exemples préexistants disponibles.

atk new les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk new:

Paramètre Obligatoire Description
--app-name -n Oui Nom de votre application.
--capability -c Oui Spécifie la fonctionnalité de l’application. Les options disponibles sont declarative-agent, basic-custom-engine-agent et weather-agent. Permet atk list templates de voir toutes les options disponibles.
--programming-language -l Non Langage de programmation. Les options disponibles sont javascript, typescriptet csharp. La valeur par défaut est javascript.
--folder -f Non Répertoire dans lequel le dossier du projet est créé. La valeur par défaut est ./.
--spfx-solution -s Non Créez ou importez une solution SharePoint Framework existante. Les options disponibles sont les suivantes : new et import. La valeur par défaut est new.
--spfx-install-latest-package Non Installez la dernière version de SharePoint Framework. La valeur par défaut est true.
--spfx-framework-type -k Non Applicable si la capacité framework est sélectionnée. Les options disponibles sont minimal, reactet none. La valeur par défaut est react.
--spfx-webpart-name -w Non Nom du composant WebPart SharePoint Framework. La valeur par défaut est helloworld.
--spfx-folder Non Répertoire ou chemin d’accès qui contient la solution SharePoint Framework existante.
--me-architecture -m Non Architecture d’extension de message basée sur la recherche. Les options disponibles sont new-api, api-specet bot. La valeur par défaut est new-api.
--openapi-spec-location -a Non Emplacement du document de description OpenAPI.
--api-operation -o Non Sélectionnez les opérations avec lesquelles Teams peut interagir.
--bot-host-type-trigger -t Non Spécifie le déclencheur pour Chat Notification Message le modèle d’application. Les options disponibles sont http-express, http-webapiet http-and-timer-functions. La valeur par défaut est http-express.

La capture d’écran montre les nouveaux paramètres atk.

atk new scénarios

Voici une liste de scénarios pour contrôler tous les paramètres avec atk new:

  • Créez un agent météo.

    atk new -c weather-agent -l typescript -n myagent -i false

  • Créez un robot de notification déclenché par minuteur.

    atk new -c notification -t timer-functions -l typescript -n myapp -i false

  • Importez une solution SharePoint Framework existante.

    atk new -c tab-spfx -s import --spfx-folder <folder-path> -n myapp -i false

atk add

Ajoutez des fonctionnalités à votre application Microsoft 365.

Command Description
atk add spfx-web-part [options] Composant WebPart SPFx auto-hébergé étroitement intégré à Microsoft 365.
atk add action [options] Une action pour étendre Copilot à l’aide de vos API.
atk add auth-config [options] Ajoutez des configurations pour prendre en charge les actions avec authentification dans l’agent déclaratif.
atk add capability [options] Possibilité d’étendre Copilot à l’aide de vos API.

atk auth

Gérer les comptes Microsoft 365 et Azure.

Command Description
atk auth list Afficher tous les comptes Microsoft 365 et Azure connectés.
atk auth login Connectez-vous à un compte Microsoft 365 ou Azure.
atk auth logout <service> Déconnectez-vous du compte Microsoft 365 ou Azure.

atk entra-app

Gérez l’application Microsoft Entra dans l’application active.

Command Description
atk entra-app update Mettez à jour l’application Microsoft Entra dans l’application actuelle.

atk env

Gérer les environnements d’application.

Command Description
atk env add Ajoutez un nouvel environnement en copiant à partir de l’environnement spécifié.
atk env list Répertorie tous les environnements disponibles.
atk env reset Réinitialisez le fichier d’environnement.

atk env scénario

Créez un environnement en copiant à partir de l’environnement de développement existant :

atk env add staging --env dev

atk help

La atk help commande affiche toutes les commandes disponibles pour l’interface de ligne de commande Microsoft 365 Agents Toolkit.

atk install

Chargez un package d’application donné dans Microsoft 365.

atk install les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk install:

Command Description
--file-path Chemin d’accès au package zip du manifeste d’application.
--xml-path Chemin d’accès au fichier XML manifest XML.
--scope Étendue de l’application. Les options disponibles sont Personnel et Partagé.

atk install scénarios

Chargez le package d’application avec le manifeste JSON dans Teams, Outlook et l’application Microsoft 365.

atk install --file-path appPackage.zip

Chargez le package d’application dans Étendue partagée avec le manifeste basé sur JSON sur Teams, Outlook et l’application Microsoft 365.

atk install --file-path appPackage.zip --scope Shared

Téléchargez le package de l’application de complément Outlook avec le manifeste XML dans Outlook.

atk install --xml-path manifest.xml

atk launchinfo

Obtenez des informations sur le lancement d’une application Microsoft 365 acquise.

atk launchinfo les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk launchinfo:

Command Description
--title-id Spécifie l’ID de titre de l’application Microsoft 365 acquise.
--manifest-id Spécifie l’ID de manifeste de l’application Microsoft 365 acquise.

atk launchinfo scénarios

Obtenez les informations de lancement de l’application Microsoft 365 acquise par l’ID de titre.

atk launchinfo --title-id U_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Obtenez les informations de lancement de l’application Microsoft 365 acquise par l’ID de manifeste.

atk launchinfo --manifest-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

atk list

Répertorier les modèles et exemples d’application Microsoft 365 disponibles.

atk list les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk list:

Command Description
atk list samples Affiche une liste des exemples d’application disponibles.
atk list templates Affiche la liste des modèles d’application disponibles.

La capture d’écran montre la liste des modèles.

atk provision

La atk provision commande exécute l’étape de provisionnement dans m365agents.yml.

Pour déclencher l’étape d’approvisionnement dans m365agents.local.yml, exécutez atk provision --env local.

atk provision les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk provision:

Paramètres Obligatoire Description
--env Non Spécifie le nom de l’environnement pour le projet généré par Microsoft 365 Agents Toolkit.
--folder -f Non Spécifie le dossier racine du projet. Valeur par défaut ../
--ignore-env-file Non Pour ignorer le chargement du fichier .env lorsque --env n’est pas spécifié.

atk deploy

La atk deploy commande exécute l’étape de déploiement dans m365agents.yml.

Pour déclencher l’étape de déploiement dans m365agents.local.yml, exécutez atk deploy --env local.

atk deploy les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk deploy:

Paramètre Obligatoire Description
--env Oui Spécifie le nom de l’environnement pour le projet généré par Microsoft 365 Agents Toolkit.
--folder -f Non Spécifie le dossier racine du projet. Valeur par défaut ../
--ignore-env-file Non Pour ignorer le chargement du fichier .env lorsque --env n’est pas spécifié.
--config-file-path -c Non Spécifie le chemin d’accès du fichier yaml de configuration.

atk package

Construisez votre application Microsoft 365 dans un package pour la publication.

atk package les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk package:

Paramètre Obligatoire Description
--env Non Spécifie le nom de l’environnement pour le projet généré par Microsoft 365 Agents Toolkit.
--env-file Non Spécifie le fichier .env qui définit les variables à remplacer dans le fichier de modèle de manifeste d’application.
--manifest-file Non Spécifie le chemin d’accès du fichier manifeste de l’application. La valeur par défaut est ./appPackage/manifest.json.
--output-folder Non Spécifie le dossier de sortie contenant le ou les manifestes. La valeur par défaut est ./appPackage/build.
--output-package-file Non Spécifie le chemin d’accès du fichier de package d’application compressé de sortie. La valeur par défaut est ./appPackage/build/appPackage.${env}.zip.
--folder -f Non Spécifie le dossier racine du projet. La valeur par défaut est ./.

atk validate

Validez l’application Microsoft 365 à l’aide d’un schéma de manifeste, de règles de validation ou de cas de test.

atk validate les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk validate:

Paramètre Obligatoire Description
--env Non Spécifie le nom de l’environnement pour le projet généré par Microsoft 365 Agents Toolkit.
--env-file Non Spécifie le fichier .env qui définit les variables à remplacer dans le fichier de modèle de manifeste d’application.
--manifest-file Non Spécifie le chemin d’accès du fichier manifeste de l’application. La valeur par défaut est ./appPackage/manifest.json.
--package-file Non Spécifie le chemin d’accès du fichier de package d’application compressé.
--output-folder Non Spécifie le dossier de sortie contenant le ou les manifestes. La valeur par défaut est ./appPackage/build.
--output-package-file Non Spécifie le chemin d’accès du fichier de package d’application compressé de sortie. La valeur par défaut est ./appPackage/build/appPackage.${env}.zip.
--folder -f Non Spécifie le dossier racine du projet. La valeur par défaut est ./.
--validate-method -m Non Spécifie la méthode de validation Valeur autorisée : validation-rules ou test-cases.

atk publish

La atk publish commande exécute l’étape de publication dans m365agents.yml.

atk publish les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk publish:

Paramètre Obligatoire Description
--env Non Spécifie le nom de l’environnement pour le projet généré par Microsoft 365 Agents Toolkit.
--env-file Non Spécifie le fichier .env qui définit les variables à remplacer dans le fichier de modèle de manifeste d’application.
--manifest-file Non Spécifie le chemin d’accès du fichier manifeste de l’application. La valeur par défaut est ./appPackage/manifest.json.
--package-file Non Spécifie le chemin d’accès du fichier de package d’application compressé.
--output-folder Non Spécifie le dossier de sortie contenant le ou les manifestes. La valeur par défaut est ./appPackage/build.
--output-package-file Non Spécifie le chemin d’accès du fichier de package d’application compressé de sortie. La valeur par défaut est ./appPackage/build/appPackage.${env}.zip.
--folder -f Non Spécifie le dossier racine du projet. La valeur par défaut est ./.

atk preview

La atk preview commande vous permet d’afficher un aperçu de votre application au cours du développement. Cette commande fournit une vue en temps réel de votre application, ce qui vous aide à identifier et à résoudre les problèmes avant le déploiement.

atk preview les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk preview:

Paramètre Obligatoire Description
--m365-host -m Non Affichez un aperçu de l’application dans Teams, Outlook ou l’application Microsoft 365. Les options disponibles sont teams, outlooket office. La valeur par défaut est teams.
--manifest-file Non Spécifie le chemin d’accès du fichier manifeste de l’application. La valeur par défaut est ./appPackage/manifest.json.
--run-command -c Non La commande démarre le service et fonctionne uniquement dans l’environnement local. Si elle n’est pas définie, elle détecte automatiquement la commande appropriée à partir du type de projet (npm run dev:atk, dotnet run, ou func start). S’il est vide, il ignore le démarrage du service local.
--running-pattern -p Non Le signal prêt indique que le service est lancé. Fonctionne uniquement pour local l’environnement. Si elle n’est pas définie, la commande La valeur par défaut est (started|successfully|finished|crashed|failed|listening|ready). Si vide, le processus démarre en tant que signal prêt.
--open-only -o Non Fonctionne uniquement pour local l’environnement. Si la valeur est true, ouvrez directement le client web sans lancer le service local. La valeur par défaut est false.
--browser -b Non Sélectionnez le navigateur pour ouvrir le client web Microsoft Teams. Les options disponibles sont chrome, edgeet default. La valeur par défaut est default.
--browser-arg -ba Non Argument à transmettre au navigateur. Par exemple : --browser-args="--guest.
--exec-path -ep Non Chemins d’accès ajoutés à la variable d’environnement système « PATH » lors de l’exécution de la commande. La valeur par défaut est devTools/func.
--desktop -d Non Si la valeur est true, ouvrez le client de bureau Teams au lieu du client web. La valeur par défaut est false.
--env Non Spécifie un environnement existant pour le projet. La valeur par défaut est local.
--folder -f Non Spécifie le dossier racine du projet. La valeur par défaut est ./.

atk preview scénarios

La atk preview commande doit être utilisée après atk provision et .atk deploy

La liste suivante fournit les scénarios courants pour atk preview:

  • Préversion locale : Voici les dépendances pour utiliser la préversion locale :

    • Node.js
    • Kit de développement logiciel .NET
    • Azure Functions Core Tools
    atk preview --env --local
atk preview --env --local --browser chrome

  • Préversion à distance

    atk preview --env --remote
atk preview --env --remote --browser edge

    Remarque

    Les journaux des services d’arrière-plan, tels que React, sont enregistrés au format ~/.fx/cli-log/local-preview/.

atk update

Mettez à jour le manifeste de l’application vers le portail des développeurs.

atk update les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk update:

Paramètre Obligatoire Description
--env Non Spécifie le nom de l’environnement pour le projet généré par Microsoft 365 Agents Toolkit.
--env-file Non Spécifie le fichier .env qui définit les variables à remplacer dans le fichier de modèle de manifeste d’application.
--manifest-file Non Spécifie le chemin d’accès du fichier manifeste de l’application. La valeur par défaut est ./appPackage/manifest.json.
--package-file Non Spécifie le chemin d’accès du fichier de package d’application compressé.
--output-folder Non Spécifie le dossier de sortie contenant le ou les manifestes. La valeur par défaut est ./appPackage/build.
--output-package-file Non Spécifie le chemin d’accès du fichier de package d’application compressé de sortie. La valeur par défaut est ./appPackage/build/appPackage.${env}.zip.
--folder -f Non Spécifie le dossier racine du projet. La valeur par défaut est ./.

atk upgrade

Mettez à niveau le projet pour qu’il fonctionne avec la dernière version de Microsoft 365 Agents Toolkit.

atk upgrade les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk upgrade:

Paramètre Obligatoire Description
--force -f Non Forcez la mise à niveau du projet pour qu’il fonctionne avec la dernière version de Microsoft 365 Agents Toolkit. La valeur par défaut est false.

atk collaborator

Vérifiez, accordez et répertoriez les autorisations pour qui peut accéder et gérer les applications et les applications Microsoft Entra.

Command Description
atk collaborator status Affiche le status d’autorisation actuel du projet.
atk collaborator grant Accordez l’autorisation pour un autre compte.

atk collaborator status les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk collaborator status:

Paramètre Obligatoire Description
--env Non Spécifie le nom de l’environnement pour le projet généré par Microsoft 365 Agents Toolkit.
--manifest-file Non Spécifie le chemin d’accès du fichier manifeste de l’application. La valeur par défaut est ./appPackage/manifest.json.
--entra-app-manifest-file -a Non Sélectionnez le chemin d’accès du fichier de modèle manifeste d’Entra. La valeur par défaut est ${folder}/aad.manifest.json.
--all -a Non Afficher tous les collaborateurs.
--folder -f Non Sélectionnez le dossier racine du projet. La valeur par défaut est ./.

atk collaborator grant les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk collaborator grant:

Paramètre Obligatoire Description
--email Non Entrez l’adresse e-mail du collaborateur.
--manifest-file Non Spécifie le chemin d’accès du fichier manifeste de l’application. La valeur par défaut est ./appPackage/manifest.json.
--entra-app-manifest-file -a Non Sélectionnez le chemin d’accès du fichier manifeste de l’application Entra. La valeur par défaut est ${folder}/aad.manifest.json.
--env Non Spécifie le nom de l’environnement pour le projet généré par Microsoft 365 Agents Toolkit.
--folder -f Non Sélectionnez le dossier racine du projet. La valeur par défaut est ./.

atk collaborator scénarios

Accordez l’autorisation à un autre compte Microsoft 365 de collaborer sur l’application.

atk collaborator grant -i false --manifest-file ./appPackage/manifest.json --env dev --email other@email.com

atk uninstall

Nettoyer les ressources associées à l’ID de manifeste, à l’ID de titre ou à un environnement dans Microsoft 365 Agents Projet généré par Toolkit. Les ressources incluent l’inscription d’applications dans le portail des développeurs, l’inscription des bots dans le portail Bot Framework et les applications personnalisées chargées dans les applications Microsoft 365.

atk uninstall les paramètres

Le tableau suivant répertorie les paramètres disponibles pour atk uninstall:

Command Description
--mode Choisissez un moyen de nettoyer les ressources de manière à ce qu’il soit propre.
--title-id Spécifie l’ID de titre de l’application Microsoft 365 installée.
--manifest-id Spécifie l’ID de manifeste de l’application Microsoft 365 installée.

atk uninstall scénarios

Supprimez l’application Microsoft 365 acquise en utilisant l’ID de titre.

atk uninstall -i false --mode title-id --title-id U_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Supprimez l’application Microsoft 365 acquise à l’aide de l’ID de manifeste.

atk uninstall -i false --mode manifest-id --manifest-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --options 'm365-app,app-registration,bot-framework-registration'

Supprimez l’application Microsoft 365 acquise à l’aide de l’environnement dans le projet généré par Microsoft 365 Agents Toolkit.

atk uninstall -i false --mode env --env xxx --options 'm365-app,app-registration,bot-framework-registration' --folder ./myapp

Désinstallez en mode interactif.

atk uninstall
  • Dernière mise à jour :