Merge pull request MicrosoftDocs#3698 from MicrosoftDocs/main63826168…

…3151558551sync_temp For protected CLA branch, push strategy should use PR and merge to target branch method to work around git push error
JohnMcPMS · Jul 28, 2023 · c552212 · c552212
2 parents 2c85a1a + c8a4409
commit c552212
Show file tree

Hide file tree

Showing 12 changed files with 351 additions and 150 deletions.
diff --git a/hub/package-manager/winget/export.md b/hub/package-manager/winget/export.md
@@ -25,19 +25,23 @@ The **export** command is often used to create a file that you can share with ot
 The following arguments are available.
 
 | Argument    | Description |
-|-------------|-------------|  
+|-------------|-------------|
 | **-o,--output** | Path to the JSON file to be created |
 
 ## Options
 
 The options allow you to customize the export experience to meet your needs.
 
 | Option    | Description |
-|----------------|-------------|  
+|----------------|-------------|
 | **-s, --source**  |  [Optional] Specifies a source to export files from. Use this option when you only want files from a specific source.  |
 | **--include-versions** | [Optional] Includes the version of the app currently installed. Use this option if you want a specific version. By default, unless specified, [**import**](./import.md) will use latest. |
 | **--accept-source-agreements** | Used to accept the source license agreement, and avoid the prompt. |
-| **--verbose-logs** | Used to override the logging setting and create a verbose log. |
+| **-?,--help** | Shows help about the selected command. |
+| **--wait** | Prompts the user to press any key before exiting. |
+| **--logs,--open-logs** | Open the default logs location. |
+| **--verbose, --verbose-logs** | Used to override the logging setting and create a verbose log. |
+| **--disable-interactivity** | Disable interactive prompts. |
 
 ## JSON schema
 
@@ -46,7 +50,7 @@ The driving force behind the **export** command is the JSON file. You can find t
 The JSON file includes the following hierarchy.
 
 | Entry      | Description |
-|-------------|-------------|  
+|-------------|-------------|
 | **Sources**  |  The sources application manifests come from.  |
 | **Packages**  |  The collection of packages to install.  |
 | **PackageIdentifier**  |  The Windows Package Manager package identifier used to specify the package.  |

diff --git a/hub/package-manager/winget/hash.md b/hub/package-manager/winget/hash.md
@@ -31,9 +31,19 @@ The following arguments are available:
 | Argument  | Description |
 |--------------|-------------|
 | **-f,--file** |  The path to the file to be hashed. |
+
+## Options
+
+The options allow you to customize the hash experience to meet your needs.
+
+| Option  | Description |
+|-------------|-------------|
 | **-m,--msix**  | Specifies that the hash command will also create the SHA-256 SignatureSha256 for use with MSIX installers. |
-| **--verbose-logs** | Used to override the logging setting and create a verbose log. |
 | **-?, --help** |  Gets additional help on this command. |
+| **--wait** | Prompts the user to press any key before exiting. |
+| **--logs,--open-logs** | Open the default logs location. |
+| **--verbose, --verbose-logs** | Used to override the logging setting and create a verbose log. |
+| **--disable-interactivity** | Disable interactive prompts. |
 
 ## Related topics
 

diff --git a/hub/package-manager/winget/import.md b/hub/package-manager/winget/import.md
@@ -23,20 +23,25 @@ The **import** command is often used to share your developer environment or buil
 The following arguments are available.
 
 | Argument    | Description |
-|-------------|-------------|  
+|-------------|-------------|
 | **-i,--import-file** | JSON file describing the packages to install. |
 
 ## Options
 
 The options allow you to customize the import experience to meet your needs.
 
 | Option      | Description |
-|-------------|-------------|  
+|-------------|-------------|
 | **--ignore-unavailable**  |  Suppresses errors if the app requested is unavailable.  |
 | **--ignore-versions** |  Ignores versions specified in the JSON file and installs the latest available version. |
+| **--no-upgrade** | Skips upgrade if an installed version already exists. |
 | **--accept-package-agreements** | Used to accept the license agreement, and avoid the prompt. |
 | **--accept-source-agreements** | Used to accept the source license agreement, and avoid the prompt. |
-| **--verbose-logs** | Used to override the logging setting and create a verbose log. |
+| **-?,--help** | Shows help about the selected command. |
+| **--wait** | Prompts the user to press any key before exiting. |
+| **--logs,--open-logs** | Open the default logs location. |
+| **--verbose, --verbose-logs** | Used to override the logging setting and create a verbose log. |
+| **--disable-interactivity** | Disable interactive prompts. |
 
 ## JSON Schema
 
@@ -45,7 +50,7 @@ The driving force behind the **import** command is the JSON file. You can find t
 The JSON file includes the following hierarchy.
 
 | Entry      | Description |
-|-------------|-------------|  
+|-------------|-------------|
 | **Sources**  |  The sources application manifests come from.  |
 | **Packages**  |  The collection of packages to install.  |
 | **PackageIdentifier**  |  The Windows Package Manager package identifier used to specify the package.  |

diff --git a/hub/package-manager/winget/install.md b/hub/package-manager/winget/install.md
@@ -8,7 +8,7 @@ ms.localizationpriority: medium
 
 # install command (winget)
 
-The **install** command of the [winget](index.md) tool installs the specified application. Use the [**search**](search.md) command to identify the application you want to install.  
+The **install** command of the [winget](index.md) tool installs the specified application. Use the [**search**](search.md) command to identify the application you want to install.
 
 The **install** command requires that you specify the exact string to install. If there is any ambiguity, you will be prompted to further filter the **install** command to  an exact application.
 
@@ -23,9 +23,8 @@ The **install** command requires that you specify the exact string to install. I
 The following arguments are available.
 
 | Argument      | Description |
-|-------------|-------------|  
+|-------------|-------------|
 | **-q,--query**  |  The query used to search for an app. |
-| **-?, --help** |  Get additional help on this command. |
 
 > [!NOTE]
 > The query argument is positional. Wild-card style syntax is not supported. This is most often the string of characters you expect to uniquely identify the package you wish to install.
@@ -35,28 +34,38 @@ The following arguments are available.
 The options allow you to customize the install experience to meet your needs.
 
 | Option  | Description |
-|-------------|-------------|  
+|-------------|-------------|
 | **-m, --manifest** |  Must be followed by the path to the manifest (YAML) file. You can use the manifest to run the install experience from a [local YAML file](#local-install). |
-| **--id**    |  Limits the install to the ID of the application.   |  
-| **--name**   |  Limits the search to the name of the application. |  
-| **--moniker**   | Limits the search to the moniker listed for the application. |  
-| **-v, --version**  |  Enables you to specify an exact version to install. If not specified, latest will install the highest versioned application. |  
-| **-s, --source**   |  Restricts the search to the source name provided. Must be followed by the source name. |  
-| **--scope**   |  Allows you to specify if the installer should target user or machine scope. See [known issues relating to package installation scope](./troubleshooting.md#scope-for-specific-user-vs-machine-wide).|  
-| **-a, --architecture**   |  Select the architecture to install. | 
-| **-e, --exact**   |   Uses the exact string in the query, including checking for case-sensitivity. It will not use the default behavior of a substring. |  
-| **-i, --interactive** |  Runs the installer in interactive mode. The default experience shows installer progress. |  
-| **-h, --silent** |  Runs the installer in silent mode. This suppresses all UI. The default experience shows installer progress. |  
+| **--id**    |  Limits the install to the ID of the application.   |
+| **--name**   |  Limits the search to the name of the application. |
+| **--moniker**   | Limits the search to the moniker listed for the application. |
+| **-v, --version**  |  Enables you to specify an exact version to install. If not specified, latest will install the highest versioned application. |
+| **-s, --source**   |  Restricts the search to the source name provided. Must be followed by the source name. |
+| **--scope**   |  Allows you to specify if the installer should target user or machine scope. See [known issues relating to package installation scope](./troubleshooting.md#scope-for-specific-user-vs-machine-wide).|
+| **-a, --architecture**   |  Select the architecture to install. |
+| **-e, --exact**   |   Uses the exact string in the query, including checking for case-sensitivity. It will not use the default behavior of a substring. |
+| **-i, --interactive** |  Runs the installer in interactive mode. The default experience shows installer progress. |
+| **-h, --silent** |  Runs the installer in silent mode. This suppresses all UI. The default experience shows installer progress. |
 | **--locale** | Specifies which locale to use (BCP47 format). |
 | **-o, --log**  |  Directs the logging to a log file. You must provide a path to a file that you have the write rights to. |
+| **--custom** | Arguments to be passed on to the installer in addition to the defaults.    |
 | **--override** | A string that will be passed directly to the installer.    |
 | **-l, --location** |    Location to install to (if supported). |
-| **--force** | Overrides the installer hash check. Not recommended. |
+| **--ignore-security-hash** |    Ignore the installer hash check failure. Not recommended. |
+| **--ignore-local-archive-malware-scan** |    Ignore the malware scan performed as part of installing an archive type package from local manifest. |
+| **--dependency-source** |    Find package dependencies using the specified source. |
 | **--accept-package-agreements** | Used to accept the license agreement, and avoid the prompt. |
 | **--accept-source-agreements** | Used to accept the source license agreement, and avoid the prompt. |
+| **--no-upgrade** |    Skips upgrade if an installed version already exists. |
 | **--header** | Optional Windows-Package-Manager REST source HTTP header. |
 | **-r, --rename** | The value to rename the executable file (portable) |
-| **--verbose-logs** | Used to override the logging setting and create a verbose log. |
+| **--uninstall-previous** | Uninstall the previous version of the package during upgrade |
+| **--force** | Direct run the command and continue with non security related issues. |
+| **-?, --help** |  Get additional help on this command. |
+| **--wait** | Prompts the user to press any key before exiting. |
+| **--logs,--open-logs** | Open the default logs location. |
+| **--verbose, --verbose-logs** | Used to override the logging setting and create a verbose log. |
+| **--disable-interactivity** | Disable interactive prompts. |
 
 ### Example queries
 
@@ -85,7 +94,7 @@ If the query provided to **winget** does not result in a single application, the
 The best way to limit the selection to one file is to use the **id** of the application combined with the **exact** query option.  For example:
 
 ```CMD
-winget install --id Git.Git -e 
+winget install --id Git.Git -e
 ```
 
 If multiple sources are configured, it is possible to have duplicate entries. Specifying a source is required to further disambiguate.
@@ -107,7 +116,7 @@ The **manifest** option enables you to install an application by passing in a YA
 Usage: `winget install --manifest \<path>`
 
 | Option  | Description |
-|---------|-------------|  
+|---------|-------------|
 |  **-m, --manifest** | The path to the manifests of the application to install. |
 
 > [!NOTE]
@@ -119,7 +128,7 @@ The log files for winget unless redirected, will be located in the following fol
 
 ## License Agreements
 
-Some applications when installed will require the user to agree to the license or other agreements before installing.  When this occurs, the Windows Package Manager will prompt the user to agree to the agreements.  If the user does not agree, the application will not install.  
+Some applications when installed will require the user to agree to the license or other agreements before installing.  When this occurs, the Windows Package Manager will prompt the user to agree to the agreements.  If the user does not agree, the application will not install.
 
 ![Image of agreement](./images/agreements.png)
 

diff --git a/hub/package-manager/winget/list.md b/hub/package-manager/winget/list.md
@@ -1,6 +1,6 @@
 ---
 title: list Command
-description: Displays the list of listed apps and if an update is available. 
+description: Displays the list of listed apps and if an update is available.
 ms.date: 05/5/2021
 ms.topic: overview
 ms.localizationpriority: medium
@@ -28,9 +28,8 @@ The **list** command also supports filters which can be used to limit your list
 The following arguments are available.
 
 | Argument      | Description |
-|-------------|-------------|  
+|-------------|-------------|
 | **-q,--query**  |  The query used to search for an app. |
-| **-?, --help** |  Get additional help on this command. |
 
 > [!NOTE]
 > The query argument is positional. Wild-card style syntax is not supported. This is most often the string of characters you expect to help find the installed package you are searching for.
@@ -40,18 +39,24 @@ The following arguments are available.
 The options allow you to customize the list experience to meet your needs.
 
 | Option      | Description |
-|-------------|-------------|  
-| **--id**    |  Limits the list to the ID of the application.   |  
-| **--name**   |  Limits the list to the name of the application. |  
-| **--moniker**   | Limits the list to the moniker listed for the application. |  
-| **-s, --source**   |  Restricts the list to the source name provided. Must be followed by the source name. |  
-| **--tag** |  Filters results by tags. |  
-| **--command** |  Filters results by command specified by the application. |  
+|-------------|-------------|
+| **--id**    |  Limits the list to the ID of the application.   |
+| **--name**   |  Limits the list to the name of the application. |
+| **--moniker**   | Limits the list to the moniker listed for the application. |
+| **-s, --source**   |  Restricts the list to the source name provided. Must be followed by the source name. |
+| **--tag** |  Filters results by tags. |
+| **--cmd, --command** |  Filters results by command specified by the application. |
 | **-n, --count** | Limits the number of apps displayed in one query.   |
-| **-e, --exact**   |   Uses the exact string in the list query, including checking for case-sensitivity. It will not use the default behavior of a substring. |  
-| **--accept-source-agreements** | Used to accept the source license agreement, and avoid the prompt. |
+| **-e, --exact**   |   Uses the exact string in the list query, including checking for case-sensitivity. It will not use the default behavior of a substring. |
+| **--scope** | Select installed package scope filter (user or machine). |
 | **--header** | Optional Windows-Package-Manager REST source HTTP header. |
-| **--verbose-logs** | Used to override the logging setting and create a verbose log. |
+| **--accept-source-agreements** | Used to accept the source license agreement, and avoid the prompt. |
+| **--upgrade-available** | Lists only packages which have an upgrade available. |
+| **-?, --help** |  Get additional help on this command. |
+| **--wait** | Prompts the user to press any key before exiting. |
+| **--logs,--open-logs** | Open the default logs location. |
+| **--verbose, --verbose-logs** | Used to override the logging setting and create a verbose log. |
+| **--disable-interactivity** | Disable interactive prompts. |
 
 ### Example queries