PowerShell Help for Microsoft.WinGet.Client #4674

denelon · 2024-07-24T21:46:25Z

I have signed the Contributor License Agreement.
This pull request is related to an issue.

Resolves: #4673

Related to:

PowerShell cmdlets need full documentation #3822

Microsoft Reviewers: Open in CodeFlow

Adding the base help files generated by platyPS.

…geManager.md Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

…ge.md Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

sdwheeler

More comments and suggestions.

More to come tomorrow.

src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md

src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

sdwheeler

More changes and comments. One more batch to follow.

src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md

src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md

src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md

src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md

sdwheeler

Final review pass. See comments and suggestions.

src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md

src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md

sdwheeler · 2024-08-09T19:20:46Z

src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md

+
+This command uninstalls a WinGet package from your computer. The command includes parameters to
+specify values used to search for installed packages. By default, all string-based searches are
+case-insensitive substring searches. Wildards are not supported. You can change the search behavior


Suggested change

case-insensitive substring searches. Wildards are not supported. You can change the search behavior

case-insensitive substring searches. Wildcards are not supported. You can change the search behavior

sdwheeler · 2024-08-09T19:22:23Z

src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md

+
+### -Custom
+
+Use this paramater to pass additional arguments to the installer. The parameter takes a single


Suggested change

Use this paramater to pass additional arguments to the installer. The parameter takes a single

Use this parameter to pass additional arguments to the installer. The parameter takes a single

sdwheeler · 2024-08-09T19:24:46Z

src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md

+This command searches the packages installed on your system and installs a newer version of the
+matching WinGet package. The command includes parameters to specify values used to search for
+packages in the configured sources. By default, the command searches all sources. By default, all
+string-based searches are case-insensitive substring searches. Wildards are not supported. You can


Suggested change

string-based searches are case-insensitive substring searches. Wildards are not supported. You can

string-based searches are case-insensitive substring searches. Wildcards are not supported. You can

sdwheeler · 2024-08-09T19:25:15Z

src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md

+
+### -Custom
+
+Use this paramater to pass additional arguments to the installer. The parameter takes a single


Suggested change

Use this paramater to pass additional arguments to the installer. The parameter takes a single

Use this parameter to pass additional arguments to the installer. The parameter takes a single

sdwheeler · 2024-08-09T19:26:12Z

src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md

+
+### -Log
+
+Specify log location for uninstall.


Suggested change

Specify log location for uninstall.

Specify the location for the installer log. The value can be a fully-qualified or relative path and

must include the file name. For example: `$env:TEMP\package.log`.

sdwheeler · 2024-08-09T19:26:35Z

src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md

+
+### -Log
+
+Specify the location for the installer log to be written.


Suggested change

Specify the location for the installer log to be written.

Specify the location for the installer log. The value can be a fully-qualified or relative path and

must include the file name. For example: `$env:TEMP\package.log`.

src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md

src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md

florelis · 2024-08-09T20:48:29Z

src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md

+
+### -Argument
+
+The URL or UNC of WinGet source. The source must respond with the WinGet REST source API.


with the WinGet REST source API

Doesn't this also support the preindexed sources?

Updated the description to include preindexed sources

florelis · 2024-08-09T20:52:34Z

src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md

+- InstallerHashOverride
+- LocalArchiveMalwareScanOverride
+- ProxyCommandLineOptions
+- DefaultProxy


I thought I had seen a previous comment about this, but DefaultProxy is not a flag that is enabled/disabled, so I don't think it works with this cmdlet

Removed DefaultProxy from this list.

src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md

florelis · 2024-08-09T21:00:09Z

src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md

+
+This command lists all of the packages installed on your system. The output includes packages
+installed from WinGet sources and packages installed by other methods. Packages that have package
+identifiers starting with `MSIX` or `ARP` were not installed from a WinGet source.


Nit: I think there are cases where a package installed from a WinGet source may not be correlated back to it

I didn't address this as I'm not quite sure how to best explain this.. 😓

src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md

florelis · 2024-08-09T21:03:10Z

src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md

+
+This command displays the WinGet settings for the current user. The settings are stored in
+`$env:LOCALAPPDATA\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\LocalState\settings.json`.
+This file only exists if you have change a user setting using the `Set-WinGetUserSettings` command.


That's not the only way settings can be changed. Maybe "...if you have changed a user setting, for example, using..."?

florelis · 2024-08-09T21:05:50Z

src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md

+### -Override
+
+Specify arguments to pass to the installer as a single string. To pass multiple arguments, include
+the arguments in the string. The arguments must be provided in the format expected by the installer.
+If the string contains spaces, it must be enclosed in quotes. This string overrides the arguments in
+the package manifest.
+


Should we clarify the difference with -Custom?

Updated description for both -Custom and -Override to clarify the difference

florelis · 2024-08-09T21:07:17Z

src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md

+This command removes a configured WinGet source. By default, there are two sources registered:
+`msstore` and `winget`. You can add more sources using `Add-WinGetSource`.


This has to be run as admin, right? Maybe we should clarify it like for other commands.

Added description that add/remove source commands must be run as admin.

florelis · 2024-08-09T21:09:07Z

src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md

+
+## DESCRIPTION
+
+This command repairs the installation of the WinGet client on your computer by installing the


This makes me think it only works if it is already installed, but it can also be used to install if it is missing, right? Should we clarify?

Updated description.

.github/actions/spelling/expect.txt

ryfu-msft · 2024-08-12T19:32:26Z

/azp run

mdanish-kh · 2024-08-12T20:00:17Z

src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md

+- InstallerHashOverride
+- LocalArchiveMalwareScanOverride
+- ProxyCommandLineOptions
+- DefaultProxy


Suggested change

- DefaultProxy

Needs to be removed in Disable cmdlet as well

Will address this in another PR

jsoref · 2024-08-12T20:43:05Z

If people want to enforce "please use contractions", this comment includes the rough changes: #4674 (comment)

denelon added 2 commits July 24, 2024 14:42

Add platyPS generated help files

801e0e3

Adding the base help files generated by platyPS.

Move files to Microsoft.WinGet.Client

22e095a

This comment was marked as outdated.

Sign in to view

denelon added 2 commits July 25, 2024 10:40

Document Add-WinGetSource

17bb1d0

fix spelling

b07eee7

This comment has been minimized.

Sign in to view

denelon added 8 commits July 25, 2024 10:49

fix spelling

84ac4ff

Add Add-WinGetSource to Microsoft.WinGet.Client.md

bc86036

Modify example 1 Add-WinGetSource

9e27d22

Put example text below example

971f11c

remove previously acknowledged words that are now absent

5badcd5

Update Assert-WinGetPackageManager

b94be9c

Add descriptions to Microsoft.WinGet.Client

670e681

Update Disable-WinGetSetting

ea7dd59

This comment has been minimized.

Sign in to view

denelon added 5 commits July 25, 2024 15:51

fix spelling

497c9dc

Update Disable-WinGetSettings

c358805

Update Export-WinGetPackage

32ab737

Update Find-WinGetPackage

8f8ee78

Update Find-WinGetPackage

6f86f45

denelon changed the title ~~Power shell help~~ PowerShell Help for Microsoft.WinGet.Client Jul 26, 2024

denelon and others added 9 commits July 26, 2024 10:31

Update Get-WinGetPackage

2383aa5

Update-Get-WinGetSettings

324430f

Update Get-WinGetSource

b6abcfb

Update-GetWinGetUserSettings

a484af6

Update Get-WinGetVersion

9199ae3

Update Install-WinGetPackage

4c93150

Updated Remove-WinGetSource

431f929

repair initial

174bd6d

Update Update-WinGetPackage

46f1f91

denelon and others added 3 commits August 7, 2024 15:27

Update src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPacka…

acdc322

…geManager.md Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

Update src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPacka…

3d92c94

…ge.md Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

Apply suggestions from code review

180b988

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

sdwheeler suggested changes Aug 8, 2024

View reviewed changes

microsoft-github-policy-service bot added Needs-Author-Feedback Issue needs attention from issue or PR author and removed Needs-Author-Feedback Issue needs attention from issue or PR author labels Aug 8, 2024

Apply suggestions from code review

0e6d287

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>

denelon marked this pull request as ready for review August 8, 2024 18:47

sdwheeler suggested changes Aug 8, 2024

View reviewed changes

microsoft-github-policy-service bot added the Needs-Author-Feedback Issue needs attention from issue or PR author label Aug 8, 2024

sdwheeler suggested changes Aug 8, 2024

View reviewed changes

resolve suggestions

e5f637c

This comment has been minimized.

Sign in to view

sdwheeler suggested changes Aug 9, 2024

View reviewed changes

address final comments

9162699

This comment has been minimized.

Sign in to view

fix spelling

963931d

florelis previously approved these changes Aug 9, 2024

View reviewed changes

address Flor's comments

b657d9b

ryfu-msft dismissed florelis’s stale review via b657d9b August 12, 2024 18:03

jsoref reviewed Aug 12, 2024

View reviewed changes

.github/actions/spelling/expect.txt Outdated Show resolved Hide resolved

.github/actions/spelling/expect.txt Outdated Show resolved Hide resolved

fixSpelling

5f5aa91

mdanish-kh reviewed Aug 12, 2024

View reviewed changes

florelis approved these changes Aug 13, 2024

View reviewed changes

ryfu-msft merged commit 5427597 into microsoft:master Aug 13, 2024
7 of 9 checks passed

microsoft-github-policy-service bot removed Needs-Attention Issue needs attention from Microsoft Needs-Author-Feedback Issue needs attention from issue or PR author labels Aug 13, 2024

denelon deleted the PowerShellHelp branch August 26, 2024 18:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PowerShell Help for Microsoft.WinGet.Client #4674

PowerShell Help for Microsoft.WinGet.Client #4674

denelon commented Jul 24, 2024 •

edited

Loading

This comment was marked as outdated.

This comment has been minimized.

This comment has been minimized.

sdwheeler left a comment

sdwheeler left a comment

sdwheeler left a comment

This comment has been minimized.

sdwheeler Aug 9, 2024

sdwheeler Aug 9, 2024

sdwheeler Aug 9, 2024

sdwheeler Aug 9, 2024

sdwheeler Aug 9, 2024

sdwheeler Aug 9, 2024

This comment has been minimized.

florelis Aug 9, 2024

ryfu-msft Aug 12, 2024

florelis Aug 9, 2024

ryfu-msft Aug 12, 2024

florelis Aug 9, 2024

ryfu-msft Aug 12, 2024

florelis Aug 9, 2024

florelis Aug 9, 2024

ryfu-msft Aug 12, 2024

florelis Aug 9, 2024

ryfu-msft Aug 12, 2024

florelis Aug 9, 2024

ryfu-msft Aug 12, 2024

ryfu-msft commented Aug 12, 2024

mdanish-kh Aug 12, 2024

ryfu-msft Aug 13, 2024

jsoref commented Aug 12, 2024

	case-insensitive substring searches. Wildards are not supported. You can change the search behavior
	case-insensitive substring searches. Wildcards are not supported. You can change the search behavior


		### -Custom

		Use this paramater to pass additional arguments to the installer. The parameter takes a single

	Use this paramater to pass additional arguments to the installer. The parameter takes a single
	Use this parameter to pass additional arguments to the installer. The parameter takes a single

	string-based searches are case-insensitive substring searches. Wildards are not supported. You can
	string-based searches are case-insensitive substring searches. Wildcards are not supported. You can

	Specify log location for uninstall.
	Specify the location for the installer log. The value can be a fully-qualified or relative path and
	must include the file name. For example: `$env:TEMP\package.log`.


		### -Log

		Specify the location for the installer log to be written.


		### -Argument

		The URL or UNC of WinGet source. The source must respond with the WinGet REST source API.

		This command removes a configured WinGet source. By default, there are two sources registered:
		`msstore` and `winget`. You can add more sources using `Add-WinGetSource`.


		## DESCRIPTION

		This command repairs the installation of the WinGet client on your computer by installing the

PowerShell Help for Microsoft.WinGet.Client #4674

PowerShell Help for Microsoft.WinGet.Client #4674

Conversation

denelon commented Jul 24, 2024 • edited Loading

Resolves: #4673

Microsoft Reviewers: Open in CodeFlow

This comment was marked as outdated.

This comment has been minimized.

This comment has been minimized.

sdwheeler left a comment

Choose a reason for hiding this comment

sdwheeler left a comment

Choose a reason for hiding this comment

sdwheeler left a comment

Choose a reason for hiding this comment

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryfu-msft commented Aug 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoref commented Aug 12, 2024

denelon commented Jul 24, 2024 •

edited

Loading