Skip to content

Commit 49cb81d

Browse files
appieschotVesaJuvonen
authored andcommitted
Added Office 365 CLI documentation (SharePoint#4148)
* Added Office 365 CLI documentation Based on the PowerShell implementation a version that contains all O365 CLI commands to easily manage site designs and site scripts from any device. * [fix] added reference from-to CLI-PowerShell * Fixed urls Added missing / to URL's * Update site-design-o365cli.md Adding opens-source / SLA details for the CLI entry.
1 parent 90dcb5f commit 49cb81d

File tree

2 files changed

+58
-1
lines changed

2 files changed

+58
-1
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: SharePoint site design - Office 365 CLI commands
3+
description: Use the Office 365 CLI to create, retrieve, and remove site designs and site scripts.
4+
ms.date: 10/23/2018
5+
localization_priority: Priority
6+
---
7+
8+
# SharePoint site design: Office 365 CLI commands
9+
10+
Use the Office 365 CLI to create, retrieve, update, and remove site designs and site scripts to new and existing modern site collections from any platform.
11+
12+
> [!NOTE]
13+
> Office 365 CLI is an open-source tool with active community providing support for it. There is no SLA for the open-source tool support from Microsoft.
14+
15+
## Getting started
16+
17+
To run the Office 365 CLI commands, you'll need to do the following:
18+
19+
1. Download and install [NodeJS LTS version](https://nodejs.org/en/)
20+
21+
2. Follow the instructions at [Installing the CLI](https://pnp.github.io/office365-cli/user-guide/installing-cli/) to install the Office 365 CLI on your machine
22+
23+
3. Follow the instructions at [Logging in to Office 365](https://pnp.github.io/office365-cli/user-guide/connecting-office-365/) to connect to your SharePoint tenant.
24+
25+
To verify your setup and connection, try using the [sitedesign list](https:/pnp.github.io/office365-cli/cmd/spo/sitedesign/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.
26+
27+
## Site design commands
28+
29+
The following commands are available for managing site designs and site scripts from the Office 365 CLI:
30+
31+
- [sitedesign add](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-add)
32+
- [sitedesign apply](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-apply)
33+
- [sitedesign get](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-get)
34+
- [sitedesign list](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-list)
35+
- [sitedesign remove](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-remove)
36+
- [sitedesign set](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-set)
37+
- [sitedesign rights grant](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-rights-grant)
38+
- [sitedesign rights list](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-rights-list)
39+
- [sitedesign rights revoke](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-rights-revoke)
40+
- [sitedesign run list](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-run-list)
41+
- [sitedesign run status get](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-run-status-get)
42+
- [sitedesign task get](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-task-get)
43+
- [sitedesign task list](https://pnp.github.io/office365-cli/cmd/spo/sitedesign/sitedesign-task-list)
44+
- [sitescript add](https://pnp.github.io/office365-cli/cmd/spo/sitescript/sitescript-add)
45+
- [sitescript get](https://pnp.github.io/office365-cli/cmd/spo/sitescript/sitescript-get)
46+
- [sitescript list](https://pnp.github.io/office365-cli/cmd/spo/sitescript/sitescript-list)
47+
- [sitescript remove](https://pnp.github.io/office365-cli/cmd/spo/sitescript/sitescript-remove)
48+
- [sitescript set](https://pnp.github.io/office365-cli/cmd/spo/sitescript/sitescript-set)
49+
50+
## See also
51+
52+
- [JSON schema reference](site-design-json-schema.md)
53+
- [REST API](site-design-rest-api.md)
54+
- [Apply a scope to your site design](site-design-scoping.md)
55+
- [SharePoint site design and site script overview](site-design-overview.md)
56+
- [SharePoint site design - PowerShell cmdlets](site-design-powershell.md)

docs/declarative-customization/site-design-powershell.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ localization_priority: Priority
88
# SharePoint site design: PowerShell cmdlets
99

1010
> [!NOTE]
11-
> Site designs and site scripts have been released to production and are available for general use.
11+
> Site designs and site scripts have been released to production and are available for general use.
1212
1313
Use PowerShell cmdlets to create, retrieve, update, and remove site designs and site scripts to new and existing modern site collections.
1414

@@ -52,3 +52,4 @@ The following cmdlets are available for managing site designs and site scripts f
5252
- [REST API](site-design-rest-api.md)
5353
- [Apply a scope to your site design](site-design-scoping.md)
5454
- [SharePoint site design and site script overview](site-design-overview.md)
55+
- [SharePoint site design - Office 365 CLI commands](site-design-o365cli.md)

0 commit comments

Comments
 (0)