https://github.com/waldekmastykarz/cli-githubactions
https://github.com/waldekmastykarz/cli-githubactions
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/waldekmastykarz/cli-githubactions
- Owner: waldekmastykarz
- License: mit
- Created: 2020-12-19T18:13:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-05T06:58:30.000Z (about 4 years ago)
- Last Synced: 2025-01-08T00:27:20.021Z (6 months ago)
- Language: TypeScript
- Size: 9.06 MB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
CLI for Microsoft 365
One CLI for Microsoft 365
CLI for Microsoft 365 helps you manage your Microsoft 365 tenant and SharePoint Framework projects.
Website |
Features |
Install |
Usage |
Build |
Contribute
Sharing is Caring |
Code of Conduct |
Disclaimer
## Features
- Run on any OS
- Linux
- MacOS
- Windows
- Run on any shell
- Azure Cloud Shell
- bash
- cmder
- PowerShell
- zsh
- Unified login
- Access all your Microsoft 365 workloads
- Supported workloads
- Azure Active Directory
- Microsoft Teams
- Microsoft To Do
- OneDrive
- Outlook
- Planner
- Power Automate
- Power Apps
- Skype for Business
- SharePoint Online
- Yammer
- Supported authentication methods
- Azure Managed Identity
- Certificate
- Device Code
- Username and Password
- Manage your SharePoint Framework projects
- Uprade your projects
- Check your environment compatibility
> Follow our [Twitter](https://twitter.com/climicrosoft365) account to keep yourself updated about new features, improvements, and bug fixes.
## Install
To install this CLI, you will need [`node`](https://nodejs.org) `>= 8.0.0` installed.
```
npm install -g @pnp/cli-microsoft365
```
Install beta version
```
npm install -g @pnp/cli-microsoft365@next
```
Alternate package managers
### yarn
```
yarn global add @pnp/cli-microsoft365
```
### npx
```
npx @pnp/cli-microsoft365
```
## Usage
Use the `login` command to start the Device Code login flow to authenticate with your Microsoft 365 tenant.
```sh
m365 login
```
>On your first login you will be asked to consent to several permissions that the `PnP Management Shell` multi-tenant app requires for the commands to work successfully against your tenant. If you want to create your own identity to use with the CLI, refer to the [Using your own Azure AD Identity](user-guide/using-own-identity/) guide.
>For alternative authentication methods and usage, refer to the [login](https://pnp.github.io/cli-microsoft365/cmd/login/) command documentation
List all commands using the global `--help` option.
```sh
m365 --help
```
Get command information and example usage using the global `--help` option.
```sh
m365 spo site get --help
```
Execute a command and output response as text.
```sh
m365 spo site get --webUrl https://contoso.sharepoint.com
```
Execute a command and output response as JSON using the global `--output` option.
```sh
m365 spo site get --webUrl https://contoso.sharepoint.com --output json
```
Filter responses and return custom objects using [JMESPath](https://jmespath.org/) queries using the global `--query` option.
```sh
m365 spo site list --output json --query '[?Template==`GROUP#0`].{Title:Title, Url:Url}'
```
> For more examples and usage, refer to the [command](https://pnp.github.io/cli-microsoft365/cmd/login/) and [sample scripts](https://pnp.github.io/cli-microsoft365/sample-scripts/) documentation.
## Build
To build and run this CLI locally, you will need [`node`](https://nodejs.org) `>= 14.0.0` installed.
```sh
# 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
```
When you execute any `m365` command from the terminal, it will now use your local clone of the CLI.
## Contribute
We love to accept contributions.
If you want to get involved with helping us grow the CLI, whether that is suggesting or adding a new command, extending an existing command or updating our documentation, we would love to hear from you.
Checkout our [Wiki](https://github.com/pnp/cli-microsoft365/wiki) for guides on how to contribute to this project.
## Sharing is Caring
This project is associated with the [Microsoft 365 Patterns and Practices](https://pnp.github.io) (PnP) organisation, which is a virtual team consisting of Microsoft employees and community members focused on helping the community make the best use of Microsoft products.
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/?WT.mc_id=m365-0000-wmastyka).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/?WT.mc_id=m365-0000-wmastyka) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
## 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.**
