CLI for Microsoft 365 について
ターミナルから Microsoft 365 サービスにアクセスします。SharePoint、Teams、Entra、Power Platform に対応しており、Microsoft Graph API と統合され、自動化向けの構造化 JSON 出力を返します。
主な機能
- 01Microsoft 365 アカウントへのログインと状態確認
- 02SharePoint サイトと Teams の一覧表示、作成、更新
- 03Microsoft Graph にクエリして組織データを取得
- 04スクリプト実行用に JSON 形式で出力
活用シーン
- 01SharePoint と Teams の設定タスクを自動化
- 02コーディングエージェントが組織リソースを管理
- 03バッチ操作とワークフロー統合
インストール
OS またはパッケージマネージャーを選び、コマンドをターミナルで実行します。
インストール後にm365 --versionを実行して確認します。
コマンド例
よく使うコマンドを使う順に並べています。
詳細
CLI for Microsoft 365
Microsoft 365 のための 1 つの CLI
CLI for Microsoft 365 を使用すると、Microsoft 365 テナントと SharePoint Framework プロジェクトを管理できます。
Web サイト | 機能 | インストール | 使用方法 | ビルド | 貢献
行動規範 | ヘルプが必要ですか? | 免責事項
Microsoft 365 と Power Platform コミュニティ
機能
- あらゆる OS で実行
- Linux
- MacOS
- Windows
- あらゆるシェルで実行
- Azure Cloud Shell
- bash
- cmder
- PowerShell
- zsh
- 統合ログイン
- Microsoft 365 のすべてのワークロードにアクセス
- 対応ワークロード
- Bookings
- Microsoft Entra ID
- Microsoft Teams
- Microsoft To Do
- Microsoft Viva
- OneDrive
- OneNote
- Outlook
- Planner
- Power Automate
- Power Apps
- Power Platform
- Purview
- SharePoint Embedded
- SharePoint Online
- SharePoint Premium
- To Do
- 対応する認証方法
- Azure Managed Identity
- 証明書
- クライアントシークレット
- デバイスコード
- フェデレーション ID
- ユーザー名とパスワード
- SharePoint Framework プロジェクトを管理
- プロジェクトをアップグレード
- 環境との互換性を確認
インストール
CLI for Microsoft 365 を使用するには、Node.js が必要です。CLI は Node.js バージョン 20 以降でテストされていますが、現時点で利用可能な Node.js LTS バージョンの使用をお勧めします。
npm install -g @pnp/cli-microsoft365
ベータ版 β のインストール
npm install -g @pnp/cli-microsoft365@next
別のパッケージマネージャー 🧶
yarn
yarn global add @pnp/cli-microsoft365
npx
npx @pnp/cli-microsoft365
Docker コンテナーで CLI for Microsoft 365 を実行する 🐳
docker run --rm -it m365pnp/cli-microsoft365:latest
Docker を使用して CLI for Microsoft 365 を実行する方法については、ガイドをご覧ください。
使用方法
ログインする前に、Microsoft Entra アプリケーションの登録をカスタムで作成してください。
m365 setupコマンドを使用するか、独自の Microsoft Entra ID の使用ガイドをご覧ください。
login コマンドを使用してデバイスコードのログインフローを開始し、Microsoft 365 テナントで認証します。
m365 login
その他の認証方法と使用方法については、login コマンドのドキュメントをご覧ください。
グローバルな --help オプションを使用して、すべてのコマンドを一覧表示します。
m365 --help
グローバルな --help オプションを使用して、コマンドの情報と使用例を確認します。
m365 spo site get --help
コマンドを実行し、応答を JSON 形式で出力します。
m365 spo site get --url https://contoso.sharepoint.com
グローバルな --query オプションを使用し、JMESPath クエリで応答をフィルター処理して、カスタムオブジェクトを返します。
m365 spo site list --query '[?Template==`GROUP#0`].{Title:Title, Url:Url}'
グローバルな --output オプションを使用し、コマンドを実行して応答をテキストとして出力します。
m365 spo site get --url https://contoso.sharepoint.com --output text
その他の例と使用方法については、command および sample scripts のドキュメントをご覧ください。
ビルド
この CLI をローカルでビルドして実行するには、node >= 24.0.0 がインストールされている必要があります。
# Clone this repository
$ git clone https://github.com/pnp/cli-microsoft365
# Go into the repository
$ cd cli-microsoft365
# Install dependencies
$ npm install
# Build the CLI
$ npm run build
# Symlink your local CLI build
$ npm link
ターミナルから任意の m365 コマンドを実行すると、ローカルにクローンした CLI が使用されるようになります。
貢献
皆さまからの貢献を歓迎します。
新しいコマンドの提案や追加、既存のコマンドの拡張、ドキュメントの更新など、CLI の発展にご協力いただける場合は、ぜひお知らせください。
このプロジェクトへの貢献方法の詳細については、貢献ガイドをご覧ください。
お困りですか?
コミュニティに参加する
Microsoft 365 & Power Platform コミュニティ
CLI for Microsoft 365 は、Microsoft 365 & Power Platform コミュニティ(PnP)のプロジェクトです。Microsoft 365 & Power Platform コミュニティは、コミュニティの皆さまが Microsoft 製品を最大限に活用できるよう支援することを目的とした、Microsoft の従業員とコミュニティメンバーからなるバーチャルチームです。CLI for Microsoft 365 は、Microsoft と提携しておらず、Microsoft のサポート対象でもないオープンソースプロジェクトです。CLI の使用中に問題が発生した場合は、issues list に問題を報告してください。
免責事項
このコードは、明示または黙示を問わず、いかなる種類の保証もなく「現状有姿」で提供されます。これには、特定目的への適合性、商品性、または権利非侵害に関する黙示的な保証も含まれます。