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
サポート対象コマンド
次の表は、開発者がエージェントまたはアプリケーションを構築および管理するのに役立つサポートされるコマンドの一覧です。
| コマンド | 説明 |
|---|---|
atk doctor |
Microsoft 365 Appsを構築するための前提条件チェッカー。 |
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 |
m365agents.ymlまたはm365agents.local.ymlでプロビジョニング ステージを実行します。 |
atk deploy |
m365agents.ymlまたはm365agents.local.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 Appsをビルドするために必要な前提条件を確認します。
atk new
atk new コマンドは既定で対話型モードで動作し、新しい Microsoft 365 アプリを作成するためのガイダンスを提供します。 非対話型モードで atk new を動作させるには、 --interactive フラグを false に設定します。
atk new
atk new -i false
| コマンド | 説明 |
|---|---|
atk new sample |
既存のサンプルからアプリを作成します。 |
atk list samples |
使用可能なすべての既存のサンプルの一覧を表示します。 |
atk new パラメーター
次の表に、 atk newで使用できるパラメーターの一覧を示します。
| パラメーター | 必須 | 説明 |
|---|---|---|
--app-name -n |
はい | アプリケーションの名前。 |
--capability -c |
はい | アプリ機能を指定します。 使用可能なオプションは、 declarative-agent、 basic-custom-engine-agent 、 weather-agentです。 使用可能なすべてのオプションを表示するには、 atk list templates を使用します。 |
--programming-language -l |
不要 | プログラミング言語。 使用可能なオプションは、 javascript、 typescript、および csharpです。 既定値は javascript です。 |
--folder -f |
いいえ | プロジェクト フォルダーが作成されるディレクトリ。 既定値は ./ です。 |
--spfx-solution -s |
いいえ | 既存のSharePoint Framework ソリューションを作成またはインポートします。 使用可能なオプションは、 new と importです。 既定値は new です。 |
--spfx-install-latest-package |
いいえ | 最新バージョンのSharePoint Frameworkをインストールします。 既定値は true です。 |
--spfx-framework-type -k |
いいえ |
framework 機能が選択されている場合に適用されます。 使用可能なオプションは、 minimal、 react、および noneです。 既定値は react です。 |
--spfx-webpart-name -w |
いいえ | SharePoint Framework Web パーツの名前。 既定値は helloworld です。 |
--spfx-folder |
いいえ | 既存のSharePoint Framework ソリューションを含むディレクトリまたはパス。 |
--me-architecture -m |
不要 | 検索ベースのメッセージ拡張機能のアーキテクチャ。 使用可能なオプションは、 new-api、 api-spec、および botです。 既定値は new-api です。 |
--openapi-spec-___location -a |
いいえ | OpenAPI の説明ドキュメントの場所。 |
--api-operation -o |
不要 | Teams が操作できる操作を選択します。 |
--bot-host-type-trigger -t |
不要 | アプリ テンプレートのトリガー Chat Notification Message 指定します。 使用可能なオプションは、 http-express、 http-webapi、および http-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 Framework ソリューションをインポートします。
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] |
Microsoft 365 と緊密に統合された自動ホステッド SPFx Web パーツ。 |
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 |
使用可能なすべての環境をListsします。 |
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 パラメーター
次の表に、 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 パラメーター
次の表に、 atk launchinfoで使用できるパラメーターの一覧を示します。
| コマンド | 説明 |
|---|---|
--title-id |
取得した Microsoft 365 アプリのタイトル ID を指定します。 |
--manifest-id |
取得した Microsoft 365 アプリのマニフェスト ID を指定します。 |
atk launchinfo シナリオ
取得した Microsoft 365 アプリの起動情報をタイトル ID で取得します。
atk launchinfo --title-id U_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
取得した Microsoft 365 アプリの起動情報をマニフェスト ID で取得します。
atk launchinfo --manifest-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
atk list
使用可能な Microsoft 365 アプリ テンプレートとサンプルを一覧表示します。
atk list パラメーター
次の表に、 atk listで使用できるパラメーターの一覧を示します。
| コマンド | 説明 |
|---|---|
atk list samples |
使用可能なアプリ サンプルの一覧を表示します。 |
atk list templates |
使用可能なアプリ テンプレートの一覧を表示します。 |
atk provision
atk provision コマンドは、m365agents.ymlでプロビジョニング ステージを実行します。
m365agents.local.ymlでプロビジョニング ステージをトリガーするには、atk provision --env localを実行します。
atk provision パラメーター
次の表に、 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 パラメーター
次の表に、 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 パラメーター
次の表に、 atk packageで使用できるパラメーターの一覧を示します。
| パラメーター | 必須 | 説明 |
|---|---|---|
--env |
いいえ | Microsoft 365 Agents Toolkit によってスキャフォールディングされたプロジェクトの環境名を指定します。 |
--env-file |
不要 | アプリ マニフェスト テンプレート ファイルで置き換える変数を定義する .env ファイルを指定します。 |
--manifest-file |
不要 | アプリ マニフェスト ファイルのパスを指定します。 既定値は ./appPackage/manifest.json です。 |
--output-folder |
いいえ | マニフェストを含む出力フォルダーを指定します。 既定値は ./appPackage/build です。 |
--output-package-file |
いいえ | 出力 zip アプリ パッケージ ファイル パスを指定します。 既定値は ./appPackage/build/appPackage.${env}.zip です。 |
--folder -f |
いいえ | プロジェクトのルート フォルダーを指定します。 既定値は ./ です。 |
atk validate
マニフェスト スキーマ、検証規則、またはテスト ケースを使用して Microsoft 365 アプリを検証します。
atk validate パラメーター
次の表に、 atk validateで使用できるパラメーターの一覧を示します。
| パラメーター | 必須 | 説明 |
|---|---|---|
--env |
いいえ | Microsoft 365 Agents Toolkit によってスキャフォールディングされたプロジェクトの環境名を指定します。 |
--env-file |
不要 | アプリ マニフェスト テンプレート ファイルで置き換える変数を定義する .env ファイルを指定します。 |
--manifest-file |
不要 | アプリ マニフェスト ファイルのパスを指定します。 既定値は ./appPackage/manifest.json です。 |
--package-file |
いいえ | zip 形式のアプリ パッケージ ファイル パスを指定します。 |
--output-folder |
不要 | マニフェストを含む出力フォルダーを指定します。 既定値は ./appPackage/build です。 |
--output-package-file |
いいえ | 出力 zip アプリ パッケージ ファイル パスを指定します。 既定値は ./appPackage/build/appPackage.${env}.zip です。 |
--folder -f |
いいえ | プロジェクトのルート フォルダーを指定します。 既定値は ./ です。 |
--validate-method -m |
いいえ | 検証メソッドの許可される値を指定します: validation-rules または test-cases。 |
atk publish
atk publish コマンドは、m365agents.ymlで発行ステージを実行します。
atk publish パラメーター
次の表に、 atk publishで使用できるパラメーターの一覧を示します。
| パラメーター | 必須 | 説明 |
|---|---|---|
--env |
いいえ | Microsoft 365 Agents Toolkit によってスキャフォールディングされたプロジェクトの環境名を指定します。 |
--env-file |
不要 | アプリ マニフェスト テンプレート ファイルで置き換える変数を定義する .env ファイルを指定します。 |
--manifest-file |
不要 | アプリ マニフェスト ファイルのパスを指定します。 既定値は ./appPackage/manifest.json です。 |
--package-file |
いいえ | zip 形式のアプリ パッケージ ファイル パスを指定します。 |
--output-folder |
不要 | マニフェストを含む出力フォルダーを指定します。 既定値は ./appPackage/build です。 |
--output-package-file |
いいえ | 出力 zip アプリ パッケージ ファイル パスを指定します。 既定値は ./appPackage/build/appPackage.${env}.zip です。 |
--folder -f |
いいえ | プロジェクトのルート フォルダーを指定します。 既定値は ./ です。 |
atk preview
atk preview コマンドを使用すると、開発中にアプリをプレビューできます。 このコマンドは、アプリのリアルタイム ビューを提供し、デプロイ前に問題を特定して修正するのに役立ちます。
atk preview パラメーター
次の表に、 atk previewで使用できるパラメーターの一覧を示します。
| パラメーター | 必須 | 説明 |
|---|---|---|
--m365-host -m |
いいえ | Teams、Outlook、または Microsoft 365 アプリでアプリケーションをプレビューします。 使用可能なオプションは、 teams、 outlook、および officeです。 既定値は 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 |
いいえ | ブラウザーを選択して Web クライアントMicrosoft Teams開きます。 使用可能なオプションは、 chrome、 edge、および defaultです。 既定値は default です。 |
--browser-arg -ba |
いいえ | ブラウザーに渡す引数。 たとえば、「 --browser-args="--guest 」のように入力します。 |
--exec-path -ep |
不要 | コマンドの実行時にシステム環境変数 "PATH" に追加されるパス。 既定値は devTools/func です。 |
--desktop -d |
いいえ | true の場合は、Web クライアントではなく Teams デスクトップ クライアントを開きます。 既定値は false です。 |
--env |
不要 | プロジェクトの既存の環境を指定します。 既定値は local です。 |
--folder -f |
いいえ | プロジェクトのルート フォルダーを指定します。 既定値は ./ です。 |
atk preview シナリオ
atk preview コマンドは、atk provisionとatk deployの後で使用する必要があります。
次の一覧は、 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 パラメーター
次の表に、 atk updateで使用できるパラメーターの一覧を示します。
| パラメーター | 必須 | 説明 |
|---|---|---|
--env |
いいえ | Microsoft 365 Agents Toolkit によってスキャフォールディングされたプロジェクトの環境名を指定します。 |
--env-file |
不要 | アプリ マニフェスト テンプレート ファイルで置き換える変数を定義する .env ファイルを指定します。 |
--manifest-file |
不要 | アプリ マニフェスト ファイルのパスを指定します。 既定値は ./appPackage/manifest.json です。 |
--package-file |
いいえ | zip 形式のアプリ パッケージ ファイル パスを指定します。 |
--output-folder |
不要 | マニフェストを含む出力フォルダーを指定します。 既定値は ./appPackage/build です。 |
--output-package-file |
いいえ | 出力 zip アプリ パッケージ ファイル パスを指定します。 既定値は ./appPackage/build/appPackage.${env}.zip です。 |
--folder -f |
いいえ | プロジェクトのルート フォルダーを指定します。 既定値は ./ です。 |
atk upgrade
Microsoft 365 Agents Toolkit の最新バージョンを使用するようにプロジェクトをアップグレードします。
atk upgrade パラメーター
次の表に、 atk upgradeで使用できるパラメーターの一覧を示します。
| パラメーター | 必須 | 説明 |
|---|---|---|
--force -f |
いいえ | Microsoft 365 Agents Toolkit の最新バージョンを使用するようにプロジェクトを強制的にアップグレードします。 既定値は falseです。 |
atk collaborator
アプリとアプリケーションにアクセスして管理できるユーザーのアクセス許可を確認、付与、一覧表示Microsoft Entra。
| コマンド | 説明 |
|---|---|
atk collaborator status |
プロジェクトの現在のアクセス許可の状態を表示します。 |
atk collaborator grant |
別のアカウントのアクセス許可を付与します。 |
atk collaborator status パラメーター
次の表に、 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 パラメーター
次の表に、 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
Microsoft 365 Agents Toolkit で生成されたプロジェクトで、マニフェスト ID、タイトル ID、または環境に関連付けられているリソースをクリーンアップします。 リソースには、開発者ポータルでのアプリの登録、Bot Framework Portal でのボットの登録、Microsoft 365 アプリでアップロードされたカスタム アプリが含まれます。
atk uninstall パラメーター
次の表に、 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
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Platform Docs