Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PowerShell Help for Microsoft.WinGet.Client #4674

Merged
merged 58 commits into from
Aug 13, 2024
Merged
Changes from 1 commit
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
801e0e3
Add platyPS generated help files
denelon Jul 24, 2024
22e095a
Move files to Microsoft.WinGet.Client
denelon Jul 24, 2024
17bb1d0
Document Add-WinGetSource
denelon Jul 25, 2024
b07eee7
fix spelling
denelon Jul 25, 2024
84ac4ff
fix spelling
denelon Jul 25, 2024
bc86036
Add Add-WinGetSource to Microsoft.WinGet.Client.md
denelon Jul 25, 2024
9e27d22
Modify example 1 Add-WinGetSource
denelon Jul 25, 2024
971f11c
Put example text below example
denelon Jul 25, 2024
5badcd5
remove previously acknowledged words that are now absent
denelon Jul 25, 2024
b94be9c
Update Assert-WinGetPackageManager
denelon Jul 25, 2024
670e681
Add descriptions to Microsoft.WinGet.Client
denelon Jul 25, 2024
ea7dd59
Update Disable-WinGetSetting
denelon Jul 25, 2024
497c9dc
fix spelling
denelon Jul 25, 2024
c358805
Update Disable-WinGetSettings
denelon Jul 25, 2024
32ab737
Update Export-WinGetPackage
denelon Jul 26, 2024
8f8ee78
Update Find-WinGetPackage
denelon Jul 26, 2024
6f86f45
Update Find-WinGetPackage
denelon Jul 26, 2024
2383aa5
Update Get-WinGetPackage
denelon Jul 26, 2024
324430f
Update-Get-WinGetSettings
denelon Jul 26, 2024
b6abcfb
Update Get-WinGetSource
denelon Jul 26, 2024
a484af6
Update-GetWinGetUserSettings
denelon Jul 26, 2024
9199ae3
Update Get-WinGetVersion
denelon Jul 26, 2024
4c93150
Update Install-WinGetPackage
denelon Jul 26, 2024
431f929
Updated Remove-WinGetSource
denelon Jul 29, 2024
174bd6d
repair initial
ryfu-msft Jul 29, 2024
46f1f91
Update Update-WinGetPackage
denelon Jul 29, 2024
cd7ee96
Update Uninstall-WinGetPackage
denelon Jul 29, 2024
9bc2f08
finish the rest of the cmdlets
ryfu-msft Jul 30, 2024
badd916
Merge branch 'PowerShellHelp' of https://github.com/denelon/winget-cl…
ryfu-msft Jul 30, 2024
e6cd16f
resolve and push changes
ryfu-msft Jul 30, 2024
d48abfa
Update Test-WinGetUserSettings
denelon Jul 30, 2024
a922bd1
Remove ProgressAction from syntax and descriptions
mdanish-kh Jul 31, 2024
4855e3a
Merge pull request #1 from mdanish-kh/removeProgressAction
denelon Jul 31, 2024
3f354f4
Merge branch 'master' into PowerShellHelp
denelon Jul 31, 2024
c94b752
Update spelling
denelon Jul 31, 2024
1fb3173
spelling
denelon Jul 31, 2024
3de666d
fix spelling
denelon Jul 31, 2024
d98528f
update spelling
denelon Jul 31, 2024
aed2778
update Add-WinGetSource
denelon Aug 1, 2024
b71ea2f
Update descriptions to present tense
denelon Aug 1, 2024
1f92ce8
Initial editorial improvements and markdownlint
denelon Aug 1, 2024
a95f845
fix spelling
denelon Aug 1, 2024
c08c4b0
spell exclude markdownlint file
denelon Aug 1, 2024
fe3b74b
Initial pass at formatting
denelon Aug 1, 2024
b87076f
Add ms.date
denelon Aug 1, 2024
1d3797d
fix typo
denelon Aug 1, 2024
7735d76
update spelling
denelon Aug 1, 2024
52bbc0b
Add title front matter
denelon Aug 1, 2024
919db64
Update src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md
denelon Aug 7, 2024
acdc322
Update src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPacka…
denelon Aug 7, 2024
3d92c94
Update src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPacka…
denelon Aug 7, 2024
180b988
Apply suggestions from code review
denelon Aug 7, 2024
0e6d287
Apply suggestions from code review
denelon Aug 8, 2024
e5f637c
resolve suggestions
ryfu-msft Aug 9, 2024
9162699
address final comments
ryfu-msft Aug 9, 2024
963931d
fix spelling
ryfu-msft Aug 9, 2024
b657d9b
address Flor's comments
ryfu-msft Aug 12, 2024
5f5aa91
fixSpelling
ryfu-msft Aug 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update Get-WinGetPackage
denelon committed Jul 26, 2024
commit 2383aa552c25106f57cc64196324d13d83ab6ab8
40 changes: 25 additions & 15 deletions src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
# Get-WinGetPackage

## SYNOPSIS
{{ Fill in the Synopsis }}
List installed packages.

## SYNTAX

@@ -19,21 +19,24 @@ Get-WinGetPackage [-Tag <String>] [-Command <String>] [-Count <UInt32>] [-Id <St
```

## DESCRIPTION
{{ Fill in the Description }}
Lists installed packages.

> **Packages with leading "ARP" or "MSIX" are installed on the device, but not correlated with any configured source.

## EXAMPLES

### Example 1
### Example 1: Default example

```powershell
PS C:\> {{ Add example code here }}
Get-WinGetPackage
```

{{ Add example description here }}
Displays installed packages.

## PARAMETERS

### -Command
{{ Fill Command Description }}
Filter results by their command

```yaml
Type: System.String
@@ -48,7 +51,7 @@ Accept wildcard characters: False
```

### -Count
{{ Fill Count Description }}
Limit the number of results

```yaml
Type: System.UInt32
@@ -63,7 +66,7 @@ Accept wildcard characters: False
```

### -Id
{{ Fill Id Description }}
Filter results by their package identifier

```yaml
Type: System.String
@@ -78,7 +81,7 @@ Accept wildcard characters: False
```

### -MatchOption
{{ Fill MatchOption Description }}
Specify the matching logic

```yaml
Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption
@@ -94,7 +97,7 @@ Accept wildcard characters: False
```

### -Moniker
{{ Fill Moniker Description }}
Filter results by package moniker

```yaml
Type: System.String
@@ -109,7 +112,7 @@ Accept wildcard characters: False
```

### -Name
{{ Fill Name Description }}
Filter results by package name

```yaml
Type: System.String
@@ -124,7 +127,10 @@ Accept wildcard characters: False
```

### -ProgressAction
{{ Fill ProgressAction Description }}

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet.

This parameter was added in PowerShell 7.4.

```yaml
Type: System.Management.Automation.ActionPreference
@@ -139,7 +145,7 @@ Accept wildcard characters: False
```

### -Query
{{ Fill Query Description }}
Specifies query string to search for

```yaml
Type: System.String[]
@@ -154,7 +160,7 @@ Accept wildcard characters: False
```

### -Source
{{ Fill Source Description }}
Specify the source

```yaml
Type: System.String
@@ -169,7 +175,7 @@ Accept wildcard characters: False
```

### -Tag
{{ Fill Tag Description }}
Filter by Tag

```yaml
Type: System.String
@@ -203,3 +209,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## NOTES

## RELATED LINKS

[Uninstall-WinGetPackage](Uninstall-WinGetPackage.md)

[Update-WinGetPackage](Update-WinGetPackage.md)
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@ Downloads a package.
Searches configured sources for packages.

### [Get-WinGetPackage](Get-WinGetPackage.md)
{{ Fill in the Description }}
List installed packages.

### [Get-WinGetSettings](Get-WinGetSettings.md)
{{ Fill in the Description }}

Unchanged files with check annotations Beta