PowerShell Help for Microsoft.WinGet.Client

.github/actions/spelling/excludes.txt

@@ -112,6 +112,7 @@
 ^src/cpprestsdk/
 ^src/JsonCppLib/
 ^src/PowerShell/ExternalModules/PowerShellGet/2\.2\.5/Modules/
+^src/PowerShell/Help/markdownlint.yaml$
 ^src/PureLib/
 ^src/SfsClient/
 ^src/UndockedRegFreeWinRT/

.github/actions/spelling/expect.txt

@@ -11,6 +11,7 @@ adml
 admx
 AFAIK
 aicli
+arning
 AICLIC
 AKV
 allusers
@@ -39,6 +40,7 @@ ASequence
 ashpatil
 Ashwini
 ASwitch
+Asn
 ASYNCRTIMP
 Atest
 ATL
@@ -85,7 +87,6 @@ CLASSNOTREG
 CLOSEAPP
 cloudapp
 clsctx
-clsid
 CMSG
 cobertura
 CODEOWNERS
@@ -135,11 +136,11 @@ dsc
 DUPLICATEALIAS
 dustojnikhummer
 dvinns
+ebug
 ecfr
 ecfrbrowse
 EFGH
 efileresource
-endregion
 ENDSESSION
 EQU
 ERANGE
@@ -148,7 +149,6 @@ errmsg
 ERRORONEXIT
 errstr
 ESRB
-ests
 etest
 etl
 execustom
@@ -256,7 +256,6 @@ ldcase
 learnxinyminutes
 lhs
 LIBYAML
-Linq
 liv
 liwpx
 localizationpriority
@@ -328,12 +327,11 @@ myinstalldir
 mylog
 mysilent
 mysilentwithprogress
-nameof
+mysource
 Nami
 nativehandle
 NBLGGH
 NESTEDINSTALLER
-netfx
 netlify
 NETSDK
 Newtonsoft
@@ -355,7 +353,6 @@ NOSEARCH
 NOSEPARATOR
 notalostreference
 NOTAPROPERTY
-notmatch
 NOTIMPL
 NOTRACK
 NOUPDATE
@@ -370,7 +367,6 @@ ofile
 oid
 omus
 onefuzz
-ools
 oop
 opensource
 OPTOUT
@@ -384,7 +380,6 @@ packageinuse
 packageinusebyapplication
 PACL
 PARAMETERMAP
-paramref
 pathparts
 Patil
 pcb
@@ -459,7 +454,6 @@ Roblox
 ronomon
 Roronoa
 rosoft
-rowids
 rowid
 roy
 RRF
@@ -532,8 +526,6 @@ TARG
 taskhostw
 tcs
 TEMPDIRECTORY
-Templating
-templating
 temppath
 testexampleinstaller
 thiscouldbeapc
@@ -544,7 +536,6 @@ tombstoned
 transitioning
 trimstart
 ttl
-typeparam
 typedef
 UCase
 ucasemap
@@ -559,7 +550,6 @@ uninstallation
 uninstaller
 uninstallprevious
 uninstalls
-Unk
 unknwn
 Unknwnbase
 UNMARSHALING
@@ -586,7 +576,6 @@ wcex
 WDAG
 webpages
 Webserver
-websites
 website
 wesome
 wfsopen

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

@@ -0,0 +1,109 @@
+---
+external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml
+Module Name: Microsoft.WinGet.Client
+ms.date: 08/01/2024
+online version:
+schema: 2.0.0
+title: Add-WinGetSource
+---
+
+# Add-WinGetSource
+
+## SYNOPSIS
+Adds a new source.
+
+## SYNTAX
+
+```
+Add-WinGetSource -Name <String> -Argument <String> [-Type <String>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+Adds a new source. A source provides the data for you to discover and install packages. Only add a
+new source if you trust it as a secure location.
+
+## EXAMPLES
+
+### Example 1: Add new REST source named mysource
+
+```powershell
+Add-WinGetSource -Name mysource -Argument https://contoso.com/ -Type Microsoft.Rest
+```
+
+This example adds a new REST source to WinGet named `mysource` with the root URL
+`https://contoso.com/`. The source must respond with the WinGet REST source API.
+
+## PARAMETERS
+
+### -Argument
+
+The URL or UNC of WinGet source. The source must respond with the WinGet REST source API.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### -Name
+
+The name used to identify the WinGet source.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### -Type
+
+The type of the WinGet source. Most sources are `Microsoft.Rest`. The WinGet community repository
+is `Microsoft.PreIndexed.Package`.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable,
+-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
+[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### System.String
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Remove-WinGetSource](Remove-WinGetSource.md)
+
+[Reset-WinGetSource](Reset-WinGetSource.md)

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

@@ -0,0 +1,147 @@
+---
+external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml
+Module Name: Microsoft.WinGet.Client
+ms.date: 08/01/2024
+online version:
+schema: 2.0.0
+title: Assert-WinGetPackageManager
+---
+
+# Assert-WinGetPackageManager
+
+## SYNOPSIS
+Verifies that WinGet is installed properly.
+
+## SYNTAX
+
+### IntegrityVersionSet (Default)
+
+```
+Assert-WinGetPackageManager [-Version <String>] [<CommonParameters>]
+```
+
+### IntegrityLatestSet
+
+```
+Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+Verifies that WinGet is installed properly.
+
+> [!NOTE]
+> The cmdlet doesn't ensure that the latest version of WinGet is installed. It just verifies that
+> the installed version of Winget is supported by installed version of the Microsoft.WinGet.Client
+> module.
+
+## EXAMPLES
+
+### Example 1: Default usage
+
+```powershell
+Assert-WinGetPackageManager
+```
+
+If the current version of WinGet is installed correctly, the command returns without error.
+
+### Example 2: Check if latest stable version is installed
+
+```powershell
+Assert-WinGetPackageManager -Latest
+```
+
+If the latest version of WinGet is compatible with the installed Microsoft.WinGet.Client module, the
+command returns without error.
+
+### Example 3: Check if latest preview version is installed
+
+```powershell
+Assert-WinGetPackageManager -IncludePreRelease
+```
+
+If the prerelease version of WinGet is compatible with the installed Microsoft.WinGet.Client module,
+the command returns without error.
+
+### Example 4: Check if specific version is installed
+
+```powershell
+Assert-WinGetPackageManager -Version v1.8.1911
+```
+
+If the specified version of WinGet is compatible with the installed Microsoft.WinGet.Client module,
+the command returns without error.
+
+## PARAMETERS
+
+### -IncludePreRelease
+
+Include preview versions of WinGet.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: IntegrityLatestSet
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -Latest
+
+Verify that the latest version of WinGet is compatible with the installed version of the
+Microsoft.WinGet.Client module.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: IntegrityLatestSet
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -Version
+
+Verify that a specific version of WinGet is installed correctly.
+
+```yaml
+Type: System.String
+Parameter Sets: IntegrityVersionSet
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
+-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable,
+-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
+[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### System.String
+
+### System.Management.Automation.SwitchParameter
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Get-WinGetVersion](Get-WinGetVersion.md)