Skip to content

Updates CLI API usage docs. Closes #5699 #7231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
officialasishkumar wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updates CLI API usage docs. Closes #5699 #7231

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae00aba
Updates CLI API usage docs. Closes #5699
officialasishkumar Apr 23, 2026
58a6dbb
Address CLI API docs review feedback
officialasishkumar May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/docs/user-guide/use-cli-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Typically, you'll work with CLI for Microsoft 365 in a command line. You'll eith

## Integrate CLI for Microsoft 365 in your app

If you build apps in Node.js, you can integrate CLI for Microsoft 365 using its API. This API lets you call any of the CLI's commands. The following examples show how you could call several CLI for Microsoft 365 commands in a Node.js app:
If you build apps in Node.js, you can integrate CLI for Microsoft 365 using its API. CLI for Microsoft 365 is published as an ES module, so an app that imports it should use ES modules as well. To add the package to your app, execute `npm install @pnp/cli-microsoft365`. This API lets you call any of the CLI's commands. The following examples show how you could call several CLI for Microsoft 365 commands in a Node.js app:

```javascript
import { executeCommand } from '@pnp/cli-microsoft365';
Expand All @@ -34,8 +34,8 @@ try {
}

const siteUrl = sites[0].Url;
// m365 spo web get --webUrl https://contoso.sharepoint.com/sites/project-x --withGroups
const siteInfo = await executeCommand('spo web get', { webUrl: siteUrl, withGroups: true });
// m365 spo web get --url https://contoso.sharepoint.com/sites/project-x --withGroups
const siteInfo = await executeCommand('spo web get', { url: siteUrl, withGroups: true });

console.log(siteInfo.stdout);

Expand Down