New command: m365 setup

[waldekmastykarz]

Usage

m365 setup [options]

Description

Configures CLI based on preferences

Options

Global options

Examples

Run the wizard to configure CLI based on preferences

m365 setup

Additional Info

The wizard command is meant to help users configure CLI based on their desired usage pattern. It asks a series of questions that determine how CLI should be configured, eg.

• are you going to use CLI for scripts or run commands yourself?
• have you use CLI for M365 in the past or are you new to it?

Provided answers will lead to configuring settings accordingly so that the CLI is optimized for the specific scenario.

Running the command again will overwrite any existing configuration preferences.

[Jwaegebaert]

Great idea! Let's also write some documenation about it in the Getting started section.

An extra fun question could be:

• Are you interested in contributing to the CLI for M365?

This in place could redirect them to the contribution section in our docs (Which is currently a WIP 😄)

[waldekmastykarz]

We should definitely include it in the Getting started section. Very good point!

Are you interested in contributing to the CLI for M365?

😄 this would be a great addition for the cli issue command!

[Adam-it]

great idea. I love it 🤩 as all wizard related issues 👍.
@waldekmastykarz maybe we could start by defining the scenarios for which CLI could be optimized and then list out the questions and the settings that need to be modified?

[waldekmastykarz]

@Adam-it let me take the issue for now and revisit when we wrote out some scenarios.

[waldekmastykarz]

OK, I've got the following setup scenarios:

How do you plan to use the CLI (configures autoOpenLinksInBrowser, copyDeviceCodeToClipboard, output, prompt and showHelpOnFailure)?
( ) Interactively
( ) Scripts

(When selected scripts in the previous question)
Are you going to use the CLI in PowerShell (configures errorOutput and printErrorsAsPlainText)?
( ) Yes
( ) No

How experienced are you in using the CLI (configures helpMode)?
( ) Beginner (full help)
( ) Proficient (minimal help)

---

How the different settings will be configured based on the selected choices:

Interactive:

• autoOpenLinksInBrowser: true
• copyDeviceCodeToClipboard: true
• output: text
• prompt: true
• showHelpOnFailure: true

Scripts:

• autoOpenLinksInBrowser: false
• copyDeviceCodeToClipboard: false
• output: json
• prompt: false
• showHelpOnFailure: false

Scripts in PowerShell?:

• errorOutput: stdout
• printErrorsAsPlainText: false

Beginner:

• helpMode: full

Experienced:

• helpMode: options

What do you think @pnp/cli-for-microsoft-365-maintainers?

@plamber did I capture settings for using CLI in PowerShell scripts correctly?

[waldekmastykarz]

Thinking of it some more...

What if you'd start the wizard by calling: m365 firstrun or m365 setup? Wouldn't it be more discoverable and new user friendly than a command consisting of a few nouns and a verb?

Could we also include something related to auth, eg. are going to use CLI with the standard or your own AAD app, delegated or app only permissions, and if needed we'd help you setup the necessary AAD app?

[martinlingstuyl]

I'd prefer m365 setup.

And I like the idea that this is more like helping you start up (user focused) instead of just configuring the various config keys (tool focused)

So +1 on the auth part. Having a few example scripts or follow up questions would be awesome.

For example:
Will you run the CLI using
A) managed identity
B) custom app registration

[waldekmastykarz]

One more thing that popped to my mind: before we apply the config, we should summarize what we'll do, and then ask user to confirm with the final Y/n, including a link to the cli config set help page where we show them how to change the different settings or cli config reset where they can reset all settings to default

[Adam-it]

One more thing that popped to my mind: before we apply the config, we should summarize what we'll do, and then ask user to confirm with the final Y/n, including a link to the cli config set help page where we show them how to change the different settings or cli config reset where they can reset all settings to default

This is an awesome suggestion. Yes let's do that 👍 The suggested setup flow seems fine for me

+1 the m365 setup seems good to me
+1 on the auth tips but I am wondering would I already include it in first go 🤔 maybe we could start with something simple like setting configuration and extend this with auth help in future (next issue/PR). what do you think?

@waldekmastykarz have I missed something? do you need clarity on something else/more?

@pnp/cli-for-microsoft-365-maintainers lets put a bit more of our attention on this one so we may open it up 👍