SharePoint site design: CLI for Microsoft 365 commands
Use the CLI for Microsoft 365 to create, retrieve, update, and remove site designs and site scripts to new and existing modern site collections from any platform.
Note
The CLI for Microsoft 365 is an open-source solution with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
Getting started
To run the CLI for Microsoft 365 commands, you'll need to do the following:
- Download and install NodeJS LTS version
- Follow the instructions at Installing the CLI to install the CLI for Microsoft 365 on your machine
- Follow the instructions at Logging in to Office 365 to connect to your SharePoint tenant.
To verify your setup and connection, try using the sitedesign list command to read the current list of site designs. If the cmdlet runs and returns with no errors, you're ready to proceed.
Site design commands
The following commands are available for managing site designs and site scripts from the CLI for Microsoft 365:
- sitedesign add
- sitedesign apply
- sitedesign get
- sitedesign list
- sitedesign remove
- sitedesign set
- sitedesign rights grant
- sitedesign rights list
- sitedesign rights revoke
- sitedesign run list
- sitedesign run status get
- sitedesign task get
- sitedesign task list
- sitescript add
- sitescript get
- sitescript list
- sitescript remove
- sitescript set
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for