pnp / cli-microsoft365

Manage Microsoft 365 and SharePoint Framework projects on any platform
https://aka.ms/cli-m365
MIT License
886 stars 314 forks source link

Extend the `m365` output #4757

Open Adam-it opened 1 year ago

Adam-it commented 1 year ago

Installed m365 and then what 🤔?

The aim of this issue is to extend the output when running m365 with additional guidance for the user on how to get started and what to do next.

What to do?

Add new guidance section

In the following place image

we should add a new section Get started with 2 new points:

Get started:

1. Sign in to your tenant:
m365 login

2. Get list of all sites in your tenant
m365 spo site list

(for now lets not do that and level it out of this issue)

Add some UI

This is the creative part 🤩. At the top of the output we should add an ASCII art banner. We need to understand what will fit the screen. Should it be the CLI logo or the full name "CLI for Microsoft 365" or maybe just "CLI for M365". example

waldekmastykarz commented 1 year ago

How about something like:


╭━┳╮╭━━╮╭━╮╱╱╱╱╭━┳━┳╮╱╱╱╱╱╭━╮╱╭━┳╮╱╭━━━┳━━━┳━━━╮
┃╭┫┃╰┃┃╯┃━╋━┳┳╮┃┃┃┃┣╋━┳┳┳━┫━╋━┫━┫╰╮┃╭━╮┃╭━━┫╭━━╯
┃╰┫╰┳┃┃╮┃╭┫╋┃╭╯┃┃┃┃┃┃━┫╭┫╋┣━┃╋┃╭┫╭┫╰╯╭╯┃╰━━┫╰━━╮
╰━┻━┻━━╯╰╯╰━┻╯╱╰┻━┻┻┻━┻╯╰━┻━┻━┻╯╰━╯╭╮╰╮┃╭━╮┣━━╮┃
╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱┃╰━╯┃╰━╯┣━━╯┃
Adam-it commented 1 year ago

How about something like:


╭━┳╮╭━━╮╭━╮╱╱╱╱╭━┳━┳╮╱╱╱╱╱╭━╮╱╭━┳╮╱╭━━━┳━━━┳━━━╮
┃╭┫┃╰┃┃╯┃━╋━┳┳╮┃┃┃┃┣╋━┳┳┳━┫━╋━┫━┫╰╮┃╭━╮┃╭━━┫╭━━╯
┃╰┫╰┳┃┃╮┃╭┫╋┃╭╯┃┃┃┃┃┃━┫╭┫╋┣━┃╋┃╭┫╭┫╰╯╭╯┃╰━━┫╰━━╮
╰━┻━┻━━╯╰╯╰━┻╯╱╰┻━┻┻┻━┻╯╰━┻━┻━┻╯╰━╯╭╮╰╮┃╭━╮┣━━╮┃
╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱┃╰━╯┃╰━╯┣━━╯┃

eee 😯. nope 😅 But lets keep the ideas coming 👍 @pnp/cli-for-microsoft-365-maintainers anyone else is up for some creative ASCIIfy work 👍

nicodecleyre commented 1 year ago

If it helps, you can try some ideas with this tool: https://manytools.org/hacker-tools/ascii-banner/

Adam-it commented 1 year ago

Let's maybe revisit this one.@pnp/cli-for-microsoft-365-maintainers let's forget for now the ASCII art. Unless someone has some suggestions? And let's focus only on the additional section what the user may do? Maybe besides suggesting to login the second thing we could suggest is now running the new setup command? What do you think?

like:

Get started:

1. Setup CLI for your needs:
m365 setup

2. Sign in to your tenant:
m365 login
arjunumenon commented 1 year ago

Pardon me for not coming to the discussion party earlier.

I think the m365 setup commands as the next step will definitely set the CLI settings for the way how the user is intended to use it for. So that is good to be given as first step.

Question on the auth part though. There was discussion on 4216 giving guidance on how to setup various auth types. So when we give login as a second step here, would be showing the details on how the various auth is available for CLI. Or would we just be invoking the default login via Device Code.

waldekmastykarz commented 1 year ago

Since this command would be likely used in interactive mode, I suggest that we go with m365 login.

Jwaegebaert commented 1 year ago

Since this command would be likely used in interactive mode

I had the same thought so m365 login would be a good start

Adam-it commented 1 year ago

ok agreed then. we should extend the m365 output with an additional get started section which will advice the m365 setup and m365 login command 👍