关于 CLI for Microsoft 365
通过命令行访问 Microsoft 365 服务,包括 SharePoint、Teams、Entra 和 Power Platform。支持 Microsoft Graph API 集成,返回结构化 JSON 数据便于自动化。
主要功能
- 01登录和管理 Microsoft 365 账户状态
- 02列表、创建和更新 SharePoint 站点和 Teams
- 03执行 Microsoft Graph 查询以访问组织数据
- 04将命令输出格式化为 JSON 便于脚本编写
适用场景
- 01自动化 SharePoint 和 Teams 配置任务
- 02编码 Agent 管理组织内的协作资源
- 03批量操作和工作流集成
安装
选择你的系统或包管理器,复制命令到终端运行。
安装完成后运行m365 --version确认安装成功。
命令示例
常用命令按使用顺序排列。
详细介绍
CLI for Microsoft 365
一个 CLI 管理 Microsoft 365
CLI for Microsoft 365 可帮助你管理 Microsoft 365 租户和 SharePoint Framework 项目。
Microsoft 365 和 Power Platform 社区
功能
- 可在任何操作系统上运行
- Linux
- MacOS
- Windows
- 可在任何 Shell 中运行
- 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
- Certificate
- Client Secret
- Device Code
- Federated identity
- Username and Password
- 管理 SharePoint Framework 项目
- 升级项目
- 检查环境兼容性
安装
要使用 Microsoft 365 CLI,你需要 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 容器中运行 Microsoft 365 CLI 🐳
docker run --rm -it m365pnp/cli-microsoft365:latest
查看我们的指南,详细了解如何使用 Docker 运行 Microsoft 365 CLI
用法
登录前,你应创建自定义的 Microsoft Entra 应用注册。使用
m365 setup命令,或参阅使用自己的 Microsoft Entra 身份指南。
使用 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
构建
要在本地构建并运行此 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 社区
Microsoft 365 CLI 是 Microsoft 365 与 Power Platform 社区(PnP)项目。Microsoft 365 与 Power Platform 社区是由 Microsoft 员工和社区成员组成的虚拟团队,致力于帮助社区充分利用 Microsoft 产品。Microsoft 365 CLI 是一个开源项目,与 Microsoft 无关,也不受 Microsoft 支持。如果你在使用 CLI 时遇到问题,请在问题列表中提交问题。
免责声明
本代码按“原样”提供,不附带任何形式的保证,无论是明示还是默示,包括任何关于适销性、特定用途适用性或不侵权的默示保证。