Added support for retrieving apps by their name solving pnp#516

waldekmastykarz · Jul 6, 2018 · 59224bc · 59224bc
1 parent 8dd78fb
commit 59224bc
Show file tree

Hide file tree

Showing 3 changed files with 490 additions and 36 deletions.
diff --git a/docs/manual/docs/cmd/spo/app/app-get.md b/docs/manual/docs/cmd/spo/app/app-get.md
@@ -13,7 +13,9 @@ spo app get [options]
 Option|Description
 ------|-----------
 `--help`|output usage information
-`-i, --id <id>`|ID of the app to retrieve information for
+`-i, --id [id]`|ID of the app to retrieve information for. Specify the `id` or the `name` but not both
+`-n, --name [name]`|Name of the app to retrieve information for. Specify the `id` or the `name` but not both
+`-u, --appCatalogUrl [appCatalogUrl]`|URL of the tenant app catalog site. If not specified, the CLI will try to resolve it automatically
 `-o, --output [output]`|Output type. `json|text`. Default `text`
 `--verbose`|Runs command with verbose logging
 `--debug`|Runs command with debug logging
@@ -33,6 +35,18 @@ Return details about the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ avai
 spo app get -i b2307a39-e878-458b-bc90-03bc578531d6
 ```
 
+Return details about the app with name _solution.sppkg_ available in the tenant app catalog. Will try to detect the app catalog URL
+
+```sh
+spo app get --name solution.sppkg
+```
+
+Return details about the app with name _solution.sppkg_ available in the tenant app catalog using the specified app catalog URL
+
+```sh
+spo app get --name solution.sppkg --appCatalogUrl https://contoso.sharepoint.com/sites/apps
+```
+
 ## More information
 
 - Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins)