Microsoft 365 Agents Toolkit 命令行界面

重要

Microsoft 不再支持 TeamsFx SDK 生成智能 智能 Microsoft 365 Copilot 副驾驶® 副驾驶®扩展、Microsoft 365 代理或现代 Teams 应用方案。 新开发不应使用 TeamsFx。 SDK 当前处于弃用模式,在 2026 年 9 月之前,将在 GitHub 上获得仅限社区的支持。

对于所有新的 Teams 代理和应用开发,请使用 Teams SDK 和 Teams 开发人员 CLI。

Microsoft 365 Agents Toolkit 命令行界面 (Agents Toolkit CLI) 是一个基于文本的命令行界面,可以帮助从终端或 CI/CD 进程为 Microsoft 365 搭建、验证和部署应用程序。 有关详细信息,请参阅 源代码 和 npm 包。

无论你是喜欢以键盘为中心的开发人员操作,还是要自动化 CI/CD 管道,Agents Toolkit CLI 都提供与 IDE 扩展相同的功能。 它提供以下功能来促进 智能 智能 Microsoft 365 Copilot 副驾驶® 副驾驶®、Microsoft Teams 和 Microsoft 365 的代理或应用的开发:

  • 协作:邀请其他开发人员协作处理 Agents Toolkit 项目以进行调试和部署。
  • 代理/应用程序创建:使用可用的模板和示例生成新的代理或应用程序。
  • 代理/应用程序预览:在 Teams、Outlook 和 Microsoft 365 应用中上传和预览代理或应用。
  • 资源预配和部署:预配必要的云资源并将应用程序部署到 Azure。
  • 验证、打包和发布:使用 CLI 命令验证、打包和发布代理或应用程序。
  • 环境管理:管理多个环境、Microsoft Entra 应用和 Teams 应用注册。

入门

从 npm 安装 @microsoft/m365agentstoolkit-cli,并运行 atk -h 以检查所有可用命令:

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

屏幕截图显示 npm 包的安装。

支持的命令

下表列出了支持的命令,可帮助开发人员构建和管理代理或应用程序:

命令 说明
atk doctor 生成 Microsoft 365 应用版的先决条件检查器。
atk new 创建新的 Microsoft 365 应用。
atk add 向 Microsoft 365 应用添加功能。
atk auth 管理 Microsoft 365 和 Azure 帐户。
atk entra-app 在当前应用程序中管理 Microsoft Entra 应用。
atk env 管理环境。
atk help 显示 Microsoft 365 Agents Toolkit CLI 帮助。
atk install 跨 Microsoft 365 上传给定的应用程序包。
atk launchinfo 获取获取的 Microsoft 365 应用的启动信息。
atk list 列出可用的 Microsoft 365 应用模板和示例。
atk provision 在 OR 中m365agents.ymlm365agents.local.yml运行预配阶段。
atk deploy 在 或 m365agents.local.yml中m365agents.yml运行部署阶段。
atk package 将 Microsoft 365 应用生成到包中以供发布。
atk validate 使用清单架构、验证规则或测试用例验证 Microsoft 365 应用。
atk publish 在 m365agents.yml中运行发布阶段。
atk preview 预览当前应用程序。
atk update 将 Microsoft 365 应用清单更新到开发人员门户。
atk upgrade 升级项目以使用最新版本的 Microsoft 365 Agents Toolkit。
atk collaborator 检查、授予和列出谁可以访问和管理 Microsoft 365 应用和 Microsoft Entra 应用程序的权限。
atk uninstall 清理与清单 ID、游戏 ID 或环境关联的资源。

屏幕截图显示可用命令的列表。

全局选项

以下是可用于每个命令的全局选项:

选项 说明
--version -v 显示 Microsoft 365 Agents Toolkit CLI 版本。
--help -h 显示 Microsoft 365 Agents Toolkit CLI 帮助。
--interactive -i 在交互模式下运行命令。 默认值为 true。
--debug 打印调试信息。 默认值为 false。
--verbose 打印诊断信息。 默认值为 false。
--telemetry 启用遥测。 默认值为 true。

屏幕截图显示全局选项的列表。

交互模式

命令具有不同的默认交互模式。 默认情况下,某些命令是交互式的,而某些命令则非交互式。 要确定命令的默认交互模式,请将该选项与特定命令一起使用 -h 。

atk doctor

该atk doctor命令检查生成 Microsoft 365 应用版所需的先决条件。

atk new

默认情况下,该 atk new 命令在交互模式下运行,并提供创建新 Microsoft 365 应用的指导。 要在非交互模式下工作 atk new ,请将 --interactive 标志设置为 false。

atk new
atk new -i false
命令 说明
atk new sample 从现有示例创建应用。
atk list samples 显示所有可用预先存在的示例的列表。

atk new parameters

下表列出了可用于以下项的 atk new参数:

参数 必需 说明
--app-name -n 是 应用程序的名称。
--capability -c 是 指定应用功能。 可用选项包括 declarative-agent和 basic-custom-engine-agentweather-agent。 用于 atk list templates 查看所有可用选项。
--programming-language -l 否 编程语言。 可用选项为 javascript、 和 typescriptcsharp。 默认值为 javascript。
--folder -f 否 创建项目文件夹的目录。 默认值为 ./。
--spfx-solution -s 否 创建或导入现有 SharePoint 框架解决方案。 可用选项包括 new 和 import。 默认值为 new。
--spfx-install-latest-package 否 安装最新版本的 SharePoint 框架。 默认值为 true。
--spfx-framework-type -k 否 如果选择了 framework 功能,则适用。 可用选项为 minimal、 和 reactnone。 默认值为 react。
--spfx-webpart-name -w 否 SharePoint 框架 Web 部件的名称。 默认值为 helloworld。
--spfx-folder 否 包含现有 SharePoint 框架解决方案的目录或路径。
--me-architecture -m 否 基于搜索的消息扩展的体系结构。 可用选项为 new-api、 和 api-specbot。 默认值为 new-api。
--openapi-spec-location -a 否 OpenAPI 说明文档位置。
--api-operation -o 否 选择 Teams 可以与之交互 () 操作。
--bot-host-type-trigger -t 否 指定应用模板的 Chat Notification Message 触发器。 可用选项为 http-express、 和 http-webapihttp-and-timer-functions。 默认值为 http-express。

截图显示攻击力新参数。

atk new 方案

以下是控制所有参数的 atk new方案列表:

  • 创建气象代理。

    atk new -c weather-agent -l typescript -n myagent -i false
    
  • 创建新的计时器触发通知机器人。

    atk new -c notification -t timer-functions -l typescript -n myapp -i false
    
  • 导入现有 SharePoint 框架解决方案。

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

atk add

向 Microsoft 365 应用添加功能。

命令 说明
atk add spfx-web-part [options] 自动承载的 SPFx Web 部件与 Microsoft 365 紧密集成。
atk add action [options] 使用 API 扩展 Copilot 的操作。
atk add auth-config [options] 添加配置以支持声明式代理中的身份验证操作。
atk add capability [options] 使用 API 扩展 Copilot 的功能。

atk auth

管理 Microsoft 365 和 Azure 帐户。

命令 说明
atk auth list 显示所有已连接的 Microsoft 365 和 Azure 帐户。
atk auth login 登录到 Microsoft 365 或 Azure 帐户。
atk auth logout <service> 注销 Microsoft 365 或 Azure 帐户。

atk entra-app

在当前应用程序中管理 Microsoft Entra 应用。

命令 说明
atk entra-app update 更新当前应用程序中的 Microsoft Entra 应用。

atk env

管理应用程序环境。

命令 说明
atk env add 通过从指定的环境复制来添加新环境。
atk env list 列出所有可用环境。
atk env reset 重置环境文件。

atk env 方案

通过从现有开发环境复制来创建新环境:

atk env add staging --env dev

atk help

该 atk help 命令显示可用于 Microsoft 365 Agents Toolkit CLI 的所有命令。

atk install

跨 Microsoft 365 上传给定的应用程序包。

atk install parameters

下表列出了可用于以下项的 atk install参数:

命令 说明
--file-path 应用清单 zip 包的路径。
--xml-path XML 清单 xml 文件的路径。
--scope 应用范围。 可用选项为“个人”和“共享”。

atk install 方案

将包含基于 JSON 的清单的应用程序包上传到 Teams、Outlook 和 Microsoft 365 应用。

atk install --file-path appPackage.zip

将具有基于 JSON 的清单的共享作用域中的应用程序包上传到 Teams、Outlook 和 Microsoft 365 应用。

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

将包含基于 XML 的清单的 Outlook 加载项应用程序包上传到 Outlook。

atk install --xml-path manifest.xml

atk launchinfo

获取获取的 Microsoft 365 应用的启动信息。

atk launchinfo parameters

下表列出了可用于以下项的 atk launchinfo参数:

命令 说明
--title-id 指定获取的 Microsoft 365 应用的游戏 ID。
--manifest-id 指定获取的 Microsoft 365 应用的清单 ID。

atk launchinfo 方案

按游戏 ID 获取获取的 Microsoft 365 应用的启动信息。

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

按清单 ID 获取获取的 Microsoft 365 应用的启动信息。

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

atk list

列出可用的 Microsoft 365 应用模板和示例。

atk list parameters

下表列出了可用于以下项的 atk list参数:

命令 说明
atk list samples 显示可用应用示例的列表。
atk list templates 显示可用应用模板的列表。

屏幕截图显示模板列表。

atk provision

该 atk provision 命令运行预 m365agents.yml配阶段。

若要在 中触发预配阶段 m365agents.local.yml,请运行 atk provision --env local.

atk provision parameters

下表列出了可用于以下项的 atk provision参数:

参数 必需 说明
--env 否 指定由 Microsoft 365 Agents Toolkit 搭建的项目基架的环境名称。
--folder -f 否 指定项目的根文件夹。 默认为 ./.
--ignore-env-file 否 在未指定 --env 时跳过加载 .env 文件。

atk deploy

该 atk deploy 命令在 中 m365agents.yml运行部署阶段。

若要在 中 m365agents.local.yml触发部署阶段,请运行 atk deploy --env local。

atk deploy parameters

下表列出了可用于以下项的 atk deploy参数:

参数 必需 说明
--env 是 指定由 Microsoft 365 Agents Toolkit 搭建的项目基架的环境名称。
--folder -f 否 指定项目的根文件夹。 默认为 ./.
--ignore-env-file 否 在未指定 --env 时跳过加载 .env 文件。
--config-file-path -c 否 指定配置 yaml 文件的路径。

atk package

将 Microsoft 365 应用生成到包中以供发布。

atk package parameters

下表列出了可用于以下项的 atk package参数:

参数 必需 说明
--env 否 指定由 Microsoft 365 Agents Toolkit 搭建的项目基架的环境名称。
--env-file 否 指定定义要在应用清单模板文件中替换的变量的 .env 文件。
--manifest-file 否 指定应用清单文件路径。 默认值为 ./appPackage/manifest.json。
--output-folder 否 指定包含清单 () 的输出文件夹。 默认值为 ./appPackage/build。
--output-package-file 否 指定输出压缩应用包文件路径。 默认值为 ./appPackage/build/appPackage.${env}.zip。
--folder -f 否 指定项目的根文件夹。 默认值为 ./。

atk validate

使用清单架构、验证规则或测试用例验证 Microsoft 365 应用。

atk validate parameters

下表列出了可用于以下项的 atk validate参数:

参数 必需 说明
--env 否 指定由 Microsoft 365 Agents Toolkit 搭建的项目基架的环境名称。
--env-file 否 指定定义要在应用清单模板文件中替换的变量的 .env 文件。
--manifest-file 否 指定应用清单文件路径。 默认值为 ./appPackage/manifest.json。
--package-file 否 指定压缩的应用包文件路径。
--output-folder 否 指定包含清单 () 的输出文件夹。 默认值为 ./appPackage/build。
--output-package-file 否 指定输出压缩应用包文件路径。 默认值为 ./appPackage/build/appPackage.${env}.zip。
--folder -f 否 指定项目的根文件夹。 默认值为 ./。
--validate-method -m 否 指定验证方法 允许的值: validation-rules 或 test-cases。

atk publish

该 atk publish 命令在 中 m365agents.yml运行发布阶段。

atk publish parameters

下表列出了可用于以下项的 atk publish参数:

参数 必需 说明
--env 否 指定由 Microsoft 365 Agents Toolkit 搭建的项目基架的环境名称。
--env-file 否 指定定义要在应用清单模板文件中替换的变量的 .env 文件。
--manifest-file 否 指定应用清单文件路径。 默认值为 ./appPackage/manifest.json。
--package-file 否 指定压缩的应用包文件路径。
--output-folder 否 指定包含清单 () 的输出文件夹。 默认值为 ./appPackage/build。
--output-package-file 否 指定输出压缩应用包文件路径。 默认值为 ./appPackage/build/appPackage.${env}.zip。
--folder -f 否 指定项目的根文件夹。 默认值为 ./。

atk preview

该 atk preview 命令允许您在开发期间预览应用。 此命令提供应用的实时视图,帮助你在部署前识别和修复问题。

atk preview parameters

下表列出了可用于以下项的 atk preview参数:

参数 必需 说明
--m365-host -m 否 在 Teams、Outlook 或 Microsoft 365 应用中预览应用程序。 可用选项为 teams、 和 outlookoffice。 默认值为 teams。
--manifest-file 否 指定应用清单文件路径。 默认值为 ./appPackage/manifest.json。
--run-command -c 否 该命令将启动服务,并且仅在本地环境中有效。 如果未定义,它会自动检测项目类型 (npm run dev:atk、 dotnet run或 func start) 中的相应命令。 如果为空,则跳过启动本地服务。
--running-pattern -p 否 服务已启动的就绪信号输出。 仅适用于 local 环境。 如果未定义,则命令默认值为 (started|successfully|finished|crashed|failed|listening|ready) 。 如果为空,则进程以就绪信号启动。
--open-only -o 否 仅适用于 local 环境。 如果为 true,则直接打开 Web 客户端而不启动本地服务。 默认值为 false。
--browser -b 否 选择浏览器以打开 Microsoft Teams Web 客户端。 可用选项为 chrome、 和 edgedefault。 默认值为 default。
--browser-arg -ba 否 要传递给浏览器的参数。 例如,--browser-args="--guest。
--exec-path -ep 否 执行命令时添加到系统环境变量“PATH”的路径。 默认值为 devTools/func。
--desktop -d 否 如果为 true,请打开 Teams 桌面客户端而不是 Web 客户端。 默认值为 false。
--env 否 指定项目的现有环境。 默认值为 local。
--folder -f 否 指定项目的根文件夹。 默认值为 ./。

atk preview 方案

该atk preview命令必须在 和 atk deploy之后atk provision使用。

下表提供了以下常见 atk preview方案:

  • 本地预览版:以下是使用本地预览版的依赖项:

    • Node.js
    • .NET SDK
    • Azure Functions Core Tools
    atk preview --env --local
    atk preview --env --local --browser chrome
    
  • 远程预览

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

    注意

    React 等后台服务的日志保存在 ~/.fx/cli-log/local-preview/ 中。

atk update

将应用清单更新到开发人员门户。

atk update parameters

下表列出了可用于以下项的 atk update参数:

参数 必需 说明
--env 否 指定由 Microsoft 365 Agents Toolkit 搭建的项目基架的环境名称。
--env-file 否 指定定义要在应用清单模板文件中替换的变量的 .env 文件。
--manifest-file 否 指定应用清单文件路径。 默认值为 ./appPackage/manifest.json。
--package-file 否 指定压缩的应用包文件路径。
--output-folder 否 指定包含清单 () 的输出文件夹。 默认值为 ./appPackage/build。
--output-package-file 否 指定输出压缩应用包文件路径。 默认值为 ./appPackage/build/appPackage.${env}.zip。
--folder -f 否 指定项目的根文件夹。 默认值为 ./。

atk upgrade

升级项目以使用最新版本的 Microsoft 365 Agents Toolkit。

atk upgrade parameters

下表列出了可用于以下项的 atk upgrade参数:

参数 必需 说明
--force -f 否 强制升级项目以使用最新版本的 Microsoft 365 Agents Toolkit。 默认值为 false。

atk collaborator

检查、授予和列出谁可以访问和管理应用和 Microsoft Entra 应用程序的权限。

命令 说明
atk collaborator status 显示项目的当前权限状态。
atk collaborator grant 授予其他帐户的权限。

atk collaborator status parameters

下表列出了可用于以下项的 atk collaborator status参数:

参数 必需 说明
--env 否 指定由 Microsoft 365 Agents Toolkit 搭建的项目基架的环境名称。
--manifest-file 否 指定应用清单文件路径。 默认值为 ./appPackage/manifest.json。
--entra-app-manifest-file -a 否 选择 Entra 清单模板文件的路径。 默认值为 ${folder}/aad.manifest.json。
--all -a 否 显示所有协作者。
--folder -f 否 选择项目的根文件夹。 默认值为 ./。

atk collaborator grant parameters

下表列出了可用于以下项的 atk collaborator grant参数:

参数 必需 说明
--email 否 输入协作者的电子邮件地址。
--manifest-file 否 指定应用清单文件路径。 默认值为 ./appPackage/manifest.json。
--entra-app-manifest-file -a 否 选择 Entra 应用清单文件的路径。 默认值为 ${folder}/aad.manifest.json。
--env 否 指定由 Microsoft 365 Agents Toolkit 搭建的项目基架的环境名称。
--folder -f 否 选择项目的根文件夹。 默认值为 ./。

atk collaborator 方案

授予另一个 Microsoft 365 帐户在应用上进行协作的权限。

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

atk uninstall

清理与清单 ID、标题 ID 或 Microsoft 365 Agents Toolkit 中环境关联的资源 工具包 生成的项目。 资源包括开发人员门户中的应用注册、Bot Framework 门户中的机器人注册以及 Microsoft 365 应用中上传的自定义应用。

atk uninstall parameters

下表列出了可用于以下项的 atk uninstall参数:

命令 说明
--mode 选择清理资源的方法。
--title-id 指定已安装的 Microsoft 365 应用的游戏 ID。
--manifest-id 指定已安装的 Microsoft 365 应用的清单 ID。

atk uninstall 方案

使用游戏 ID 删除获取的 Microsoft 365 应用程序。

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

使用清单 ID 删除获取的 Microsoft 365 应用程序。

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

在 Microsoft 365 Agents Toolkit 生成的项目中删除获取的 Microsoft 365 应用程序使用环境。

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

在交互模式下卸载。

atk uninstall