Compartir a través de

Interfaz de línea de comandos de Microsoft 365 Agents Toolkit

Importante

El SDK de TeamsFx estará oficialmente en desuso en septiembre de 2025, y el soporte técnico continuará hasta septiembre de 2026. Se recomienda planear la transición al SDK de Teams para crear agentes en Microsoft Teams. Para ampliar las funcionalidades del agente en otras plataformas de Microsoft 365, use la SDK de agentes de Microsoft 365.

La interfaz de línea de comandos de Microsoft 365 Agents Toolkit (CLI de Agents Toolkit) es una interfaz de línea de comandos basada en texto que puede ayudar a aplicar scaffolding, validar e implementar aplicaciones para Microsoft 365 desde el terminal o un proceso de CI/CD. Para obtener más información, consulte código fuente y paquete npm.

Tanto si prefiere operaciones de desarrollador centradas en el teclado como si va a automatizar la canalización de CI/CD, la CLI de Agents Toolkit ofrece las mismas características que las extensiones del IDE. Proporciona las siguientes características para facilitar el desarrollo de agentes o aplicaciones para Microsoft 365 Copilot, Microsoft Teams y Microsoft 365:

  • Colaboración: invite a otros desarrolladores a colaborar en el proyecto de Agents Toolkit para depurar e implementar.
  • Creación de agentes o aplicaciones: genere un nuevo agente o aplicación mediante plantillas y ejemplos disponibles.
  • Versión preliminar del agente o la aplicación: cargue y obtenga una vista previa del agente o la aplicación en Teams, Outlook y la aplicación de Microsoft 365.
  • Aprovisionamiento e implementación de recursos: aprovisione los recursos en la nube necesarios e implemente la aplicación en Azure.
  • Validación, empaquetado y publicación: valide, empaquete y publique el agente o la aplicación mediante comandos de la CLI.
  • Administración del entorno: administre varios entornos, aplicaciones Microsoft Entra y registro de aplicaciones de Teams.

Introducción

Instale @microsoft/m365agentstoolkit-cli desde npm y ejecute atk -h para comprobar todos los comandos disponibles:

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

Captura de pantalla que muestra la instalación del paquete npm.

Comandos admitidos

En la tabla siguiente se enumeran los comandos admitidos para ayudar a los desarrolladores a compilar y administrar agentes o aplicaciones:

Comando Descripción
atk doctor Comprobador de requisitos previos para compilar Aplicaciones Microsoft 365.
atk new Cree una nueva aplicación de Microsoft 365.
atk add Agregue la característica a la aplicación de Microsoft 365.
atk auth Administrar cuentas de Microsoft 365 y Azure.
atk entra-app Administre la aplicación Microsoft Entra en la aplicación actual.
atk env Administrar entornos.
atk help Mostrar la ayuda de la CLI de Microsoft 365 Agents Toolkit.
atk install Cargue un paquete de aplicación determinado en Microsoft 365.
atk launchinfo Obtenga información de inicio de una aplicación de Microsoft 365 adquirida.
atk list Enumera las plantillas y ejemplos de aplicaciones de Microsoft 365 disponibles.
atk provision Ejecute la fase de aprovisionamiento en m365agents.yml o m365agents.local.yml.
atk deploy Ejecute la fase de implementación en m365agents.yml o m365agents.local.yml.
atk package Compile la aplicación de Microsoft 365 en un paquete para su publicación.
atk validate Valide la aplicación de Microsoft 365 mediante el esquema de manifiesto, las reglas de validación o los casos de prueba.
atk publish Ejecute la fase de publicación en m365agents.yml.
atk preview Obtener una vista previa de la aplicación actual.
atk update Actualice el manifiesto de aplicación de Microsoft 365 al Portal para desarrolladores.
atk upgrade Actualice el proyecto para que funcione con la versión más reciente de Microsoft 365 Agents Toolkit.
atk collaborator Compruebe, conceda y muestre permisos para quién puede acceder y administrar la aplicación de Microsoft 365 y Microsoft Entra aplicación.
atk uninstall Limpie los recursos asociados con el identificador de manifiesto, el identificador de título o un entorno.

Captura de pantalla que muestra la lista de comandos disponibles.

Opciones globales

A continuación se muestran las opciones globales que puede usar con cada comando:

Opciones Description
--version -v Mostrar la versión de la CLI de Microsoft 365 Agents Toolkit.
--help -h Mostrar la ayuda de la CLI de Microsoft 365 Agents Toolkit.
--interactive -i Ejecute el comando en modo interactivo. El valor predeterminado es true.
--debug Imprimir información de depuración. El valor predeterminado es False.
--verbose Imprimir información de diagnóstico. El valor predeterminado es False.
--telemetry Habilita la telemetría. El valor predeterminado es true.

Captura de pantalla que muestra la lista de opciones globales.

Modo interactivo

Los comandos tienen diferentes modos interactivos predeterminados. Algunos comandos son interactivos de forma predeterminada y otros no son interactivos. Para determinar el modo interactivo predeterminado de un comando, use la -h opción con el comando específico.

atk doctor

El atk doctor comando comprueba los requisitos previos necesarios para compilar Aplicaciones Microsoft 365.

atk new

El atk new comando funciona en modo interactivo de forma predeterminada y proporciona instrucciones para crear una nueva aplicación de Microsoft 365. Para trabajar atk new en un modo no interactivo, establezca la --interactive marca falseen .

atk new
atk new -i false
Comando Descripción
atk new sample Cree una aplicación a partir de un ejemplo existente.
atk list samples Muestra una lista de todos los ejemplos existentes disponibles.

atk new Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk new:

Parámetro Obligatorio Descripción
--app-name -n Sí Nombre de la aplicación.
--capability -c Sí Especifica la característica de la aplicación. Las opciones disponibles son declarative-agent, basic-custom-engine-agent y weather-agent. Use atk list templates para ver todas las opciones disponibles.
--programming-language -l No Lenguaje de programación. Las opciones disponibles son javascript, typescripty csharp. El valor predeterminado es javascript.
--folder -f No Directorio donde se crea la carpeta del proyecto. El valor predeterminado es ./.
--spfx-solution -s No Cree o importe una solución SharePoint Framework existente. Las opciones disponibles son new y import. El valor predeterminado es new.
--spfx-install-latest-package No Instale la versión más reciente de SharePoint Framework. El valor predeterminado es true.
--spfx-framework-type -k No Aplicable si la funcionalidad framework está seleccionada. Las opciones disponibles son minimal, reacty none. El valor predeterminado es react.
--spfx-webpart-name -w No Nombre de SharePoint Framework elemento web. El valor predeterminado es helloworld.
--spfx-folder No Directorio o ruta de acceso que contiene la solución de SharePoint Framework existente.
--me-architecture -m No Arquitectura de la extensión de mensaje basada en búsqueda. Las opciones disponibles son new-api, api-specy bot. El valor predeterminado es new-api.
--openapi-spec-location -a No Ubicación del documento de descripción de OpenAPI.
--api-operation -o No Seleccione las operaciones con las que Teams puede interactuar.
--bot-host-type-trigger -t No Especifica el desencadenador para la Chat Notification Message plantilla de aplicación. Las opciones disponibles son http-express, http-webapiy http-and-timer-functions. El valor predeterminado es http-express.

Captura de pantalla que muestra los nuevos parámetros de la atk.

atk new Escenarios

A continuación se muestra una lista de escenarios para controlar todos los parámetros con atk new:

  • Cree un agente meteorológico.

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

  • Cree un nuevo bot de notificación desencadenada por el temporizador.

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

  • Importe una solución de SharePoint Framework existente.

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

atk add

Agregue la característica a la aplicación de Microsoft 365.

Comando Descripción
atk add spfx-web-part [options] Elemento web SPFx hospedado automáticamente estrechamente integrado con Microsoft 365.
atk add action [options] Una acción para ampliar Copilot mediante las API.
atk add auth-config [options] Agregue configuraciones para admitir acciones con autenticación en el agente declarativo.
atk add capability [options] Una capacidad para ampliar Copilot mediante las API.

atk auth

Administrar cuentas de Microsoft 365 y Azure.

Comando Descripción
atk auth list Mostrar todas las cuentas de Microsoft 365 y Azure conectadas.
atk auth login Inicie sesión en Microsoft 365 o Azure cuenta.
atk auth logout <service> Cierre la sesión de Microsoft 365 o Azure cuenta.

atk entra-app

Administre la aplicación Microsoft Entra en la aplicación actual.

Comando Descripción
atk entra-app update Actualice la aplicación Microsoft Entra en la aplicación actual.

atk env

Administrar entornos de aplicación.

Comando Descripción
atk env add Agregar un nuevo entorno copiando desde el entorno especificado.
atk env list Enumera todos los entornos disponibles.
atk env reset Restablezca el archivo de entorno.

atk env Escenario

Cree un nuevo entorno copiando desde el entorno de desarrollo existente:

atk env add staging --env dev

atk help

El atk help comando muestra todos los comandos disponibles para la CLI de Microsoft 365 Agents Toolkit.

atk install

Cargue un paquete de aplicación determinado en Microsoft 365.

atk install Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk install:

Comando Descripción
--file-path Ruta de acceso al paquete zip del manifiesto de aplicación.
--xml-path Ruta de acceso al archivo XML del manifiesto XML.
--scope Ámbito de la aplicación. Las opciones disponibles son Personal y Compartido.

atk install Escenarios

Cargue el paquete de aplicación con el manifiesto basado en JSON en Teams, Outlook y la aplicación de Microsoft 365.

atk install --file-path appPackage.zip

Cargue el paquete de aplicación en Ámbito compartido con manifiesto basado en JSON en Teams, Outlook y la aplicación de Microsoft 365.

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

Cargue el paquete de aplicación del complemento de Outlook con el manifiesto basado en XML en Outlook.

atk install --xml-path manifest.xml

atk launchinfo

Obtenga información de inicio de una aplicación de Microsoft 365 adquirida.

atk launchinfo Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk launchinfo:

Comando Descripción
--title-id Especifica el identificador de título de la aplicación de Microsoft 365 adquirida.
--manifest-id Especifica el identificador de manifiesto de la aplicación de Microsoft 365 adquirida.

atk launchinfo Escenarios

Obtenga información de inicio de la aplicación de Microsoft 365 adquirida por identificador de título.

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

Obtenga información de inicio de la aplicación de Microsoft 365 adquirida por identificador de manifiesto.

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

atk list

Enumera las plantillas y ejemplos de aplicaciones de Microsoft 365 disponibles.

atk list Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk list:

Comando Descripción
atk list samples Muestra una lista de ejemplos de aplicaciones disponibles.
atk list templates Muestra una lista de plantillas de aplicación disponibles.

Captura de pantalla que muestra la lista de plantillas.

atk provision

El atk provision comando ejecuta la fase de aprovisionamiento en m365agents.yml.

Para desencadenar la fase de aprovisionamiento en m365agents.local.yml, ejecute atk provision --env local.

atk provision Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk provision:

Parameters Obligatorio Descripción
--env No Especifica el nombre del entorno del proyecto scaffoldinged by Microsoft 365 Agents Toolkit.
--folder -f No Especifica la carpeta raíz del proyecto. El valor predeterminado es ./.
--ignore-env-file No Para omitir la carga del archivo .env cuando no se especifica --env.

atk deploy

El atk deploy comando ejecuta la fase de implementación en m365agents.yml.

Para desencadenar la fase de implementación en m365agents.local.yml, ejecute atk deploy --env local.

atk deploy Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk deploy:

Parámetro Obligatorio Descripción
--env Sí Especifica el nombre del entorno del proyecto scaffoldinged by Microsoft 365 Agents Toolkit.
--folder -f No Especifica la carpeta raíz del proyecto. El valor predeterminado es ./.
--ignore-env-file No Para omitir la carga del archivo .env cuando no se especifica --env.
--config-file-path -c No Especifica la ruta de acceso del archivo yaml de configuración.

atk package

Compile la aplicación de Microsoft 365 en un paquete para su publicación.

atk package Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk package:

Parámetro Obligatorio Descripción
--env No Especifica el nombre del entorno del proyecto scaffoldinged by Microsoft 365 Agents Toolkit.
--env-file No Especifica el archivo .env que define las variables que se van a reemplazar en el archivo de plantilla de manifiesto de aplicación.
--manifest-file No Especifica la ruta de acceso del archivo de manifiesto de la aplicación. El valor predeterminado es ./appPackage/manifest.json.
--output-folder No Especifica la carpeta de salida que contiene los manifiestos. El valor predeterminado es ./appPackage/build.
--output-package-file No Especifica la ruta de acceso del archivo de paquete de aplicación comprimido de salida. El valor predeterminado es ./appPackage/build/appPackage.${env}.zip.
--folder -f No Especifica la carpeta raíz del proyecto. El valor predeterminado es ./.

atk validate

Valide la aplicación de Microsoft 365 mediante el esquema de manifiesto, las reglas de validación o los casos de prueba.

atk validate Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk validate:

Parámetro Obligatorio Descripción
--env No Especifica el nombre del entorno del proyecto scaffoldinged by Microsoft 365 Agents Toolkit.
--env-file No Especifica el archivo .env que define las variables que se van a reemplazar en el archivo de plantilla de manifiesto de aplicación.
--manifest-file No Especifica la ruta de acceso del archivo de manifiesto de la aplicación. El valor predeterminado es ./appPackage/manifest.json.
--package-file No Especifica la ruta de acceso del archivo de paquete de la aplicación comprimida.
--output-folder No Especifica la carpeta de salida que contiene los manifiestos. El valor predeterminado es ./appPackage/build.
--output-package-file No Especifica la ruta de acceso del archivo de paquete de aplicación comprimido de salida. El valor predeterminado es ./appPackage/build/appPackage.${env}.zip.
--folder -f No Especifica la carpeta raíz del proyecto. El valor predeterminado es ./.
--validate-method -m No Especifica el método de validación Valor permitido: validation-rules o test-cases.

atk publish

El atk publish comando ejecuta la fase de publicación en m365agents.yml.

atk publish Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk publish:

Parámetro Obligatorio Descripción
--env No Especifica el nombre del entorno del proyecto scaffoldinged by Microsoft 365 Agents Toolkit.
--env-file No Especifica el archivo .env que define las variables que se van a reemplazar en el archivo de plantilla de manifiesto de aplicación.
--manifest-file No Especifica la ruta de acceso del archivo de manifiesto de la aplicación. El valor predeterminado es ./appPackage/manifest.json.
--package-file No Especifica la ruta de acceso del archivo de paquete de la aplicación comprimida.
--output-folder No Especifica la carpeta de salida que contiene los manifiestos. El valor predeterminado es ./appPackage/build.
--output-package-file No Especifica la ruta de acceso del archivo de paquete de aplicación comprimido de salida. El valor predeterminado es ./appPackage/build/appPackage.${env}.zip.
--folder -f No Especifica la carpeta raíz del proyecto. El valor predeterminado es ./.

atk preview

El atk preview comando permite obtener una vista previa de la aplicación durante el desarrollo. Este comando proporciona una vista en tiempo real de la aplicación, lo que le ayuda a identificar y corregir problemas antes de la implementación.

atk preview Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk preview:

Parámetro Obligatorio Descripción
--m365-host -m No Obtenga una vista previa de la aplicación en Teams, Outlook o la aplicación de Microsoft 365. Las opciones disponibles son teams, outlooky office. El valor predeterminado es teams.
--manifest-file No Especifica la ruta de acceso del archivo de manifiesto de la aplicación. El valor predeterminado es ./appPackage/manifest.json.
--run-command -c No El comando inicia el servicio y solo funciona en el entorno local. Si no está definido, detecta automáticamente el comando adecuado del tipo de proyecto (npm run dev:atk, dotnet runo func start). Si está vacío, omite el inicio del servicio local.
--running-pattern -p No Salida de señal lista que se inicia el servicio. Solo funciona para el local entorno. Si no está definido, el comando El valor predeterminado es (started|successfully|finished|crashed|failed|listening|ready). Si está vacío, el proceso se inicia como señal lista.
--open-only -o No Solo funciona para el local entorno. Si es true, abra directamente el cliente web sin iniciar el servicio local. El valor predeterminado es false.
--browser -b No Seleccione el explorador para abrir el cliente web de Microsoft Teams. Las opciones disponibles son chrome, edgey default. El valor predeterminado es default.
--browser-arg -ba No Argumento que se va a pasar al explorador. Por ejemplo, --browser-args="--guest.
--exec-path -ep No Rutas de acceso que se agregan a la variable de entorno del sistema "PATH" cuando se ejecuta el comando. El valor predeterminado es devTools/func.
--desktop -d No Si es true, abra el cliente de escritorio de Teams en lugar del cliente web. El valor predeterminado es False.
--env No Especifica un entorno existente para el proyecto. El valor predeterminado es local.
--folder -f No Especifica la carpeta raíz del proyecto. El valor predeterminado es ./.

atk preview Escenarios

El atk preview comando debe usarse después atk provision de y atk deploy.

En la lista siguiente se proporcionan los escenarios comunes para atk preview:

  • Versión preliminar local: las siguientes son las dependencias para usar la versión preliminar local:

    • Node.js
    • SDK de .NET
    • Azure Functions Core Tools
    atk preview --env --local
atk preview --env --local --browser chrome

  • Vista previa remota

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

    Nota:

    Los registros de los servicios en segundo plano, como React, se guardan en ~/.fx/cli-log/local-preview/.

atk update

Actualice el manifiesto de la aplicación al Portal para desarrolladores.

atk update Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk update:

Parámetro Obligatorio Descripción
--env No Especifica el nombre del entorno del proyecto scaffoldinged by Microsoft 365 Agents Toolkit.
--env-file No Especifica el archivo .env que define las variables que se van a reemplazar en el archivo de plantilla de manifiesto de aplicación.
--manifest-file No Especifica la ruta de acceso del archivo de manifiesto de la aplicación. El valor predeterminado es ./appPackage/manifest.json.
--package-file No Especifica la ruta de acceso del archivo de paquete de la aplicación comprimida.
--output-folder No Especifica la carpeta de salida que contiene los manifiestos. El valor predeterminado es ./appPackage/build.
--output-package-file No Especifica la ruta de acceso del archivo de paquete de aplicación comprimido de salida. El valor predeterminado es ./appPackage/build/appPackage.${env}.zip.
--folder -f No Especifica la carpeta raíz del proyecto. El valor predeterminado es ./.

atk upgrade

Actualice el proyecto para que funcione con la versión más reciente de Microsoft 365 Agents Toolkit.

atk upgrade Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk upgrade:

Parámetro Obligatorio Descripción
--force -f No Forzar la actualización del proyecto para que funcione con la versión más reciente de Microsoft 365 Agents Toolkit. El valor predeterminado es false.

atk collaborator

Compruebe, conceda y enumere los permisos para quién puede acceder y administrar la aplicación y Microsoft Entra aplicación.

Comando Descripción
atk collaborator status Muestra el estado de permiso actual del proyecto.
atk collaborator grant Conceda permiso para otra cuenta.

atk collaborator status Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk collaborator status:

Parámetro Obligatorio Descripción
--env No Especifica el nombre del entorno del proyecto scaffoldinged by Microsoft 365 Agents Toolkit.
--manifest-file No Especifica la ruta de acceso del archivo de manifiesto de la aplicación. El valor predeterminado es ./appPackage/manifest.json.
--entra-app-manifest-file -a No Seleccione la ruta de acceso del archivo de plantilla de manifiesto entra. El valor predeterminado es ${folder}/aad.manifest.json.
--all -a No Mostrar todos los colaboradores.
--folder -f No Seleccione la carpeta raíz del proyecto. El valor predeterminado es ./.

atk collaborator grant Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk collaborator grant:

Parámetro Obligatorio Descripción
--email No Escriba la dirección de correo electrónico del colaborador.
--manifest-file No Especifica la ruta de acceso del archivo de manifiesto de la aplicación. El valor predeterminado es ./appPackage/manifest.json.
--entra-app-manifest-file -a No Seleccione la ruta de acceso del archivo de manifiesto de la aplicación Entra. El valor predeterminado es ${folder}/aad.manifest.json.
--env No Especifica el nombre del entorno del proyecto scaffoldinged by Microsoft 365 Agents Toolkit.
--folder -f No Seleccione la carpeta raíz del proyecto. El valor predeterminado es ./.

atk collaborator Escenarios

Conceda permiso para que otra cuenta de Microsoft 365 colabore en la aplicación.

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

atk uninstall

Limpie los recursos asociados con el identificador de manifiesto, el identificador de título o un entorno en el proyecto generado por Microsoft 365 Agents Toolkit. Entre los recursos se incluyen el registro de aplicaciones en el Portal para desarrolladores, el registro de bots en Bot Framework Portal y las aplicaciones personalizadas cargadas en aplicaciones de Microsoft 365.

atk uninstall Parámetros

En la tabla siguiente se enumeran los parámetros disponibles para atk uninstall:

Comando Descripción
--mode Elija una manera de limpiar los recursos.
--title-id Especifica el identificador de título de la aplicación de Microsoft 365 instalada.
--manifest-id Especifica el identificador de manifiesto de la aplicación de Microsoft 365 instalada.

atk uninstall Escenarios

Quite la aplicación de Microsoft 365 adquirida mediante el identificador de título.

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

Quite la aplicación de Microsoft 365 adquirida mediante el identificador de manifiesto.

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

Quite la aplicación de Microsoft 365 adquirida mediante el entorno en el proyecto generado por Microsoft 365 Agents Toolkit.

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

Desinstale en modo interactivo.

atk uninstall
  • Last updated on