Manage Microsoft Office 365 and SharePoint Framework projects on any platform
Clone or download

README.md

Office 365 CLI

@latest (master) @next (dev)
CircleCI CircleCI
Coverage Status Coverage Status

Office 365 CLI

Join the chat at https://gitter.im/office365-cli/cli

Using the Office 365 CLI, you can manage your Microsoft Office 365 tenant and SharePoint Framework projects on any platform. No matter if you are on Windows, macOS or Linux, using Bash, Cmder or PowerShell, using the Office 365 CLI you can configure Office 365, manage SharePoint Framework projects and build automation scripts.

asciicast

Installation

The Office 365 CLI is distributed as an NPM package. To use it, install it globally using:

npm i -g @pnp/office365-cli

or using yarn:

yarn global add @pnp/office365-cli

The beta version of the Office 365 CLI can be installed by using the @next tag:

npm i -g @pnp/office365-cli@next

Getting started

Start the Office 365 CLI by typing in the command line:

$ office365

o365$ _

Running the office365 command will start the immersive CLI with its own command prompt.

Start managing the settings of your Office 365 tenant by logging in to it, using the spo login <url> site, for example:

o365$ spo login https://contoso-admin.sharepoint.com

Depending on which settings you want to manage you might need to log in either to your tenant admin site (URL with -admin in it), or to a regular SharePoint site. For more information refer to the help of the command you want to use.

To list all available commands, type in the Office 365 CLI prompt help:

o365$ help

To exit the CLI, type exit:

o365$ exit

See the User Guide to learn more about the Office 365 CLI and its capabilities.

Sharing is Caring

We'd love your help! If you have ideas for new features or feedback, let us know by creating an issue in the issues list. Before you submit a PR with your improvements, please review our project guides.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

SharePoint Patterns and Practices

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.

telemetry