@pnp/cli-microsoft365 5.1.0-beta.ffd9bc8 → 5.2.0-beta.90d2227

package/docs/docs/cmd/spfx/project/project-doctor.md

@@ -0,0 +1,64 @@
+# spfx project doctor
+
+Validates correctness of a SharePoint Framework project
+
+## Usage
+
+```sh
+m365 spfx project doctor [options]
+```
+
+## Options
+
+`--packageManager [packageManager]`
+: The package manager you use. Supported managers `npm,pnpm,yarn`. Default `npm`
+
+`-h, --help`
+: output usage information
+
+`--query [query]`
+: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
+
+`-o, --output [output]`
+: Output type. `json,text,tour,csv`. Default `json`
+
+`--verbose`
+: Runs command with verbose logging
+
+`--debug`
+: Runs command with debug logging
+
+!!! important
+    Run this command in the folder where the project that you want to validate is located. This command doesn't change your project files.
+
+## Remarks
+
+The `spfx project doctor` command helps you validate that your SharePoint Framework project is set up correctly. The command automatically detects the version of your project using version information specified in the project's .yo-rc.json file or package.json (if no version information is included in .yo-rc.json). Based on the detected project version, the command executes several checks and reports any issues in the specified format.
+
+This command doesn't change your project files. Instead, it gives you a report with all steps necessary to validate your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
+
+## Examples
+
+Validate if your project is correctly set up and save the findings in a Markdown file
+
+```sh
+m365 spfx project doctor --output md > "doctor-report.md"
+```
+
+Validate if your project is correctly set up and show the summary of the findings in the terminal
+
+```sh
+m365 spfx project doctor --output text
+```
+
+Validate if your project is correctly set up and get instructions to fix any issues using pnpm
+
+```sh
+m365 spfx project doctor --packageManager pnpm --output text
+```
+
+Validate if your project is correctly set up and get instructions to fix any issues in a [CodeTour](https://aka.ms/codetour) file
+
+```sh
+m365 spfx project doctor --output tour
+```

package/docs/docs/cmd/spfx/spfx-doctor.md

@@ -20,7 +20,7 @@ m365 spfx doctor [options]
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
 
 `-o, --output [output]`
-: Output type. `json,text,csv,md`. Default `json`
+: Output type. `text`. Default `text`
 
 `--verbose`
 : Runs command with verbose logging
@@ -43,6 +43,9 @@ If you miss any required tools or use a version that doesn't meet the SharePoint
 
 Next to verifying the readiness of your environment to use a particular version of the SharePoint Framework, you can also check if the version of the SharePoint Framework that you use is compatible with the specific version of SharePoint. Supported versions are `sp2016`, `sp2019` and `spo`.
 
+!!! important
+    This command supports only text output.
+
 ## Examples
 
 Verify if your environment meets the requirements to work with the SharePoint Framework

package/docs/docs/cmd/spo/app/app-teamspackage-download.md

@@ -0,0 +1,56 @@
+# spo app teamspackage download
+
+Downloads Teams app package for an SPFx solution deployed to tenant app catalog
+
+## Usage
+
+```sh
+m365 spo app teamspackage download [options]
+```
+
+## Options
+
+`--appItemUniqueId [appItemUniqueId]`
+: The unique ID of the SPFx app to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName`
+
+`--appItemId [appItemId]`
+: The ID of the list item behind the SPFx app to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName`
+
+`--appName [appName]`
+: The name of the sppkg file to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName`
+
+`--fileName [fileName]`
+: Name of the file to save the package to. If not specified will use the name of the sppkg file with a `.zip` extension
+
+`-u, --appCatalogUrl [appCatalogUrl]`
+: URL of the tenant app catalog. If not specified, the command will try to autodiscover it
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+Download the Teams app package for an SPFx solution works only for solutions deployed to the tenant app catalog.
+
+If you try to download Teams app package for an SPFx solution that doesn't support deployment to Teams, you'll get the _Request failed with status code 404_ error.
+
+For maximum performance, specify the URL of the tenant app catalog, the item ID (`appItemId`) of the SPFx package for which you want to download the Teams app package and the name of the file where you want to save the downloaded package to (`fileName`).
+
+## Examples
+
+Downloads the Teams app package for the SPFx solution deployed to the tenant app catalog with the ID `1` to a file with .zip extension named after the .sppkg file:
+
+```sh
+m365 spo app teamspackage download --appItemId 1
+```
+
+Downloads the Teams app package for the SPFx solution deployed to the tenant app catalog with the unique item ID `335a5612-3e85-462d-9d5b-c014b5abeac5` to the specified file:
+
+```sh
+m365 spo app teamspackage download --appItemUniqueId 335a5612-3e85-462d-9d5b-c014b5abeac5 --fileName my-app.zip
+```
+
+Downloads the Teams app package for the SPFx solution deployed to the specified tenant app catalog:
+
+```sh
+m365 spo app teamspackage download --appName my-app.sppkg --appCatalogUrl https://contoso.sharepoint.com/sites/appcatalog
+```

package/docs/docs/cmd/teams/chat/chat-get.md

@@ -0,0 +1,53 @@
+# teams chat get
+
+Get a Microsoft Teams chat conversation by id, participants or chat name.
+
+## Usage
+
+```sh
+m365 teams chat get [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: The ID of the chat conversation. Specify either `id`, `name` or `participants`, but not multiple.
+
+`-n, --name [name]`
+: The display name of the chat conversation. Specify either `id`, `name` or `participants`, but not multiple.
+
+`-p, --participants [participants]`
+: A comma-separated list of one or more e-mail addresses. Specify either `id`, `name` or `participants`, but not multiple.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+The output will not include the chat conversation members or messages. It will just retrieve the conversation details.
+When using the `participants` option, the signed-in user will automatically be included as a participant. There's no need to add it to the list manually.
+
+## Examples
+
+Get a Microsoft Teams chat conversation by id
+
+```sh
+m365 teams chat get --id 19:2da4c29f6d7041eca70b638b43d45437@thread.v2
+```
+
+Get a Microsoft Teams one on one chat conversation, finding it by participant.
+
+```sh
+m365 teams chat get --participants alexw@contoso.com
+```
+
+Get a Microsoft Teams group chat conversation, finding it by participants.
+
+```sh
+m365 teams chat get --participants alexw@contoso.com,meganb@contoso.com
+```
+
+Get a Microsoft Teams chat conversation, finding it by display name
+
+```sh
+m365 teams chat get --name "Just a conversation"
+```