diff --git a/.github/actions/spelling/excludes.txt b/.github/actions/spelling/excludes.txt index 39eacfc234..749d52c670 100644 --- a/.github/actions/spelling/excludes.txt +++ b/.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/ diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 2e7b385c62..261cb571f8 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -39,6 +39,7 @@ ASequence ashpatil Ashwini ASwitch +Asn ASYNCRTIMP Atest ATL @@ -85,7 +86,6 @@ CLASSNOTREG CLOSEAPP cloudapp clsctx -clsid CMSG cobertura CODEOWNERS @@ -139,7 +139,6 @@ ecfr ecfrbrowse EFGH efileresource -endregion ENDSESSION EQU ERANGE @@ -148,7 +147,6 @@ errmsg ERRORONEXIT errstr ESRB -ests etest etl execustom @@ -256,7 +254,6 @@ ldcase learnxinyminutes lhs LIBYAML -Linq liv liwpx localizationpriority @@ -328,12 +325,11 @@ myinstalldir mylog mysilent mysilentwithprogress -nameof +mysource Nami nativehandle NBLGGH NESTEDINSTALLER -netfx netlify NETSDK Newtonsoft @@ -355,7 +351,6 @@ NOSEARCH NOSEPARATOR notalostreference NOTAPROPERTY -notmatch NOTIMPL NOTRACK NOUPDATE @@ -370,7 +365,6 @@ ofile oid omus onefuzz -ools oop opensource OPTOUT @@ -384,7 +378,6 @@ packageinuse packageinusebyapplication PACL PARAMETERMAP -paramref pathparts Patil pcb @@ -459,7 +452,6 @@ Roblox ronomon Roronoa rosoft -rowids rowid roy RRF @@ -532,8 +524,6 @@ TARG taskhostw tcs TEMPDIRECTORY -Templating -templating temppath testexampleinstaller thiscouldbeapc @@ -544,7 +534,6 @@ tombstoned transitioning trimstart ttl -typeparam typedef UCase ucasemap @@ -559,7 +548,6 @@ uninstallation uninstaller uninstallprevious uninstalls -Unk unknwn Unknwnbase UNMARSHALING @@ -586,7 +574,6 @@ wcex WDAG webpages Webserver -websites website wesome wfsopen diff --git a/.github/actions/spelling/patterns.txt b/.github/actions/spelling/patterns.txt index 467cd6ec80..e52a81ae81 100644 --- a/.github/actions/spelling/patterns.txt +++ b/.github/actions/spelling/patterns.txt @@ -76,8 +76,8 @@ GetRestAPIBaseUri\(".*"\) == L".*" (?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|) # Compiler flags -(?:^|[\t ,"'`=(])-[D](?!ata|ependency|epth|esktop|estination|ev|irectory|ownload) -(?:^|[\t ,"'`=(])-[W](?!ait|in|orking) +(?:^|[\t ,"'`=(])-[D](?!ata|ebug|ependency|epth|esktop|estination|ev|irectory|ownload) +(?:^|[\t ,"'`=(])-[W](?!ait|arning|in|orking) (?:^|[\t ,"'`=(])-[l](?!og) (?:^|[\t ,"'`=(])-[f](?!eatures|ile|ind) -T(?=h[a-z]{2,}) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md new file mode 100644 index 0000000000..ca1c4c9c71 --- /dev/null +++ b/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 -Argument [-Type ] [] +``` + +## 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. This command must be executed with administrator permissions. + +## 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 either a pre-indexed WinGet source or a 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) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md new file mode 100644 index 0000000000..727ecf6358 --- /dev/null +++ b/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 ] [] +``` + +### IntegrityLatestSet + +``` +Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [] +``` + +## 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) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md new file mode 100644 index 0000000000..d363183c25 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -0,0 +1,87 @@ +--- +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: Disable-WinGetSetting +--- + +# Disable-WinGetSetting + +## SYNOPSIS +Disables an administrative setting. + +## SYNTAX + +``` +Disable-WinGetSetting [-Name] [] +``` + +## DESCRIPTION + +This command disables an administrative setting. The command must be run from an elevated session +using the **Run as Administrator** option. + +This command support the following administrative settings: + +- LocalManifestFiles +- BypassCertificatePinningForMicrosoftStore +- InstallerHashOverride +- LocalArchiveMalwareScanOverride +- ProxyCommandLineOptions +- DefaultProxy + +Administrative settings are disabled by default. Administrative settings can also be managed using +Group Policy objects. + +## EXAMPLES + +### Example 1: Disable the use of local manifest files + +```powershell +Disable-WinGetSetting -Name LocalManifestFiles +``` + +This example shows how to disable the use of local manifest files. + +## PARAMETERS + +### -Name + +The name of the WinGet administrative setting. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +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 + +[Get-WinGetSettings](Get-WinGetSettings.md) + +[Set-WinGetUserSettings](Set-WinGetUserSettings.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md new file mode 100644 index 0000000000..d4b03f2b9e --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md @@ -0,0 +1,87 @@ +--- +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: Enable-WinGetSetting +--- + +# Enable-WinGetSetting + +## SYNOPSIS + +Enables WinGet administrative settings. + +## SYNTAX + +``` +Enable-WinGetSetting [-Name] [] +``` + +## DESCRIPTION + +This command enables an administrative setting. The command must be run from an elevated session +using the **Run as Administrator** option. + +This command support the following administrative settings: + +- LocalManifestFiles +- BypassCertificatePinningForMicrosoftStore +- InstallerHashOverride +- LocalArchiveMalwareScanOverride +- ProxyCommandLineOptions + +Administrative settings are disabled by default. Administrative settings can also be managed using +Group Policy objects. + +## EXAMPLES + +### Example 1 + +```powershell +Enable-WinGetSetting -Name LocalManifestFiles +``` + +This example shows how to enable the use of local manifest files. + +## PARAMETERS + +### -Name + +The name of the WinGet administrative setting. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +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 + +[Get-WinGetSettings](Get-WinGetSettings.md) + +[Disable-WinGetSetting](Disable-WinGetSetting.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md new file mode 100644 index 0000000000..e6e81882b7 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -0,0 +1,436 @@ +--- +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: Export-WinGetPackage +--- + +# Export-WinGetPackage + +## SYNOPSIS +Downloads a WinGet package and its dependencies. + +## SYNTAX + +### FoundSet (Default) + +``` +Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] + [-Architecture ] [-InstallerType ] [-Locale ] + [-Scope ] [-SkipDependencies] [-Version ] [-Id ] [-Name ] + [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] + [-WhatIf] [-Confirm] [] +``` + +### GivenSet + +``` +Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] + [-Architecture ] [-InstallerType ] [-Locale ] + [-Scope ] [-SkipDependencies] [[-PSCatalogPackage] ] + [-Version ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This command downloads a WinGet package from a configured source. The command downloads the package, +its manifest, as well as its dependencies and their manifests. By default, the packages are +downloaded to your `Downloads` folder. You can use the **DownloadDirectory** parameter to change +the location. + +For Microsoft Azure users, if the package is coming from the Microsoft Store, the command also +downloads the package license file. The user needs to have one of the following Roles in Azure: + +- Global Administrator +- User Administrator +- License Administrator + +## EXAMPLES + +### Example 1: Download Microsoft.PowerShell to the default location + +```powershell +Export-WinGetPackage -Id Microsoft.PowerShell +``` + +```Output +Id Name Source Status ExtendedErrorCode CorrelationData +-- ---- ------ ------ ----------------- --------------- +Microsoft.PowerShell PowerShell winget Ok +``` + +```powershell +dir ~\Downloads\Microsoft.PowerShell_7.4.4.0 +``` + +```Output + Directory: C:\Users\user1\Downloads\Microsoft.PowerShell_7.4.4.0 + +Mode LastWriteTime Length Name +---- ------------- ------ ---- +-a--- 8/7/2024 2:05 PM 108404736 PowerShell_7.4.4.0_Machine_X64_wix_en-US.msi +-a--- 8/7/2024 2:05 PM 3838 PowerShell_7.4.4.0_Machine_X64_wix_en-US.yaml +``` + +This example shows how to download a package for the current machine and scope. For this example, +the command downloads the latest version of the installer package and manifest for +Microsoft.PowerShell. The command puts the files a new folder in your `Downloads` location. The +folder name is created by concatenating the package identifier and version number. + +## PARAMETERS + +### -AllowHashMismatch + +Allows you to download package even when the SHA256 hash for an installer or a dependency does not +match the SHA256 hash in the WinGet package manifest. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Architecture + +Specify the processor architecture for the WinGet package installer. + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture +Parameter Sets: (All) +Aliases: +Accepted values: Default, X86, Arm, X64, Arm64 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DownloadDirectory + +Specify the location where you want to store the downloaded files. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id + +Specify the WinGet package identifier + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstallerType + +Specify the type of installer package to download. This parameter accepts the following values: + +- `Default` +- `Inno` +- `Wix` +- `Msi` +- `Nullsoft` +- `Zip` +- `Msix` +- `Exe` +- `Burn` +- `MSStore` +- `Portable` + +> [!NOTE] +> The installer type must be available in the WinGet package manifest. + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType +Parameter Sets: (All) +Aliases: +Accepted values: Default, Inno, Wix, Msi, Nullsoft, Zip, Msix, Exe, Burn, MSStore, Portable + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Locale + +Specify the locale of the installer package. The locale must provided in the BCP 47 format, such as +`en-US`. For more information, see +[Standard locale names](/globalization/locale/standard-locale-names). + +> [!NOTE] +> The locale must be available in the WinGet package manifest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MatchOption + +Specify the match option for a WinGet package query. This parameter accepts the following values: + +- `Equals` +- `EqualsCaseInsensitive` +- `StartsWithCaseInsensitive` +- `ContainsCaseInsensitive` + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption +Parameter Sets: FoundSet +Aliases: +Accepted values: Equals, EqualsCaseInsensitive, StartsWithCaseInsensitive, ContainsCaseInsensitive + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Moniker + +Specify the moniker of the WinGet package to download. For example, the moniker for the +Microsoft.PowerShell package is `pwsh`. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name + +Specify the name of the WinGet package. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PSCatalogPackage + +Provide **PSCatalogPackage** object. You can get a **PSCatalogPackage** object by using the +`Find-WinGetPackage` command. + +```yaml +Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage +Parameter Sets: GivenSet +Aliases: InputObject + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Query + +One or more strings to search for in the WinGet package. The command searches for matching strings +in the following properties of the package manifest: + +- `PackageName` +- `PackageIdentifier` +- `Moniker` +- `Tags` + +```yaml +Type: System.String[] +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope + +Specify WinGet package installer scope. The parameter accepts the following values: + +- `Any` +- `User` +- `System` +- `UserOrUnknown` +- `SystemOrUnknown` + +> [!NOTE] +> The installer scope must be available in the WinGet package manifest. + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope +Parameter Sets: (All) +Aliases: +Accepted values: Any, User, System, UserOrUnknown, SystemOrUnknown + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipDependencies + +Specifies that the command shouldn't download the WinGet package dependencies. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Source + +Specifies WinGet source. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version + +Specifies the version of the WinGet package to download. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture + +### Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType + +### Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope + +### Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage + +### System.String[] + +### Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption + +## OUTPUTS + +### Microsoft.WinGet.Client.Engine.PSObjects.PSDownloadResult + +## NOTES + +## RELATED LINKS + +[Find-WinGetPackage](Find-WinGetPackage.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md new file mode 100644 index 0000000000..30e3ed283e --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -0,0 +1,252 @@ +--- +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: Find-WinGetPackage +--- + +# Find-WinGetPackage + +## SYNOPSIS +Searches for packages from configured sources. + +## SYNTAX + +``` +Find-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id ] [-Name ] + [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] + [] +``` + +## DESCRIPTION + +Searches for packages from configured sources. + +## EXAMPLES + +### Example 1: Search for PowerShell + +```powershell +Find-WinGetPackage PowerShell +``` + +This example shows how to search for packages related to PowerShell. By default, the command +searches all configured sources. The command compares the value provided to the following package +manifest properties: + +- `PackageIdentifier` +- `PackageName` +- `Moniker` +- `Tags` + +The command does a case-insensitive substring comparison of these properties. + +### Example 2: Search for Microsoft.PowerShell by id + +```powershell +Find-WinGetPackage -Id Microsoft.PowerShell +``` + +This example shows how to search for packages by package identifier. By default, the command +searches all configured sources. The command performs a case-insensitive substring match against the +**PackageIdentifier** property of the packages. + +### Example 3: Search for Microsoft.PowerShell by exact id + +```powershell +Find-WinGetPackage -Id Microsoft.PowerShell -MatchOption Equals +``` + +This example shows how to search for packages by exact package identifier. By default, the command +searches all configured sources. The command performs a case-sensitive full text match against the +**PackageIdentifier** property of the packages. + +## PARAMETERS + +### -Command + +Specify the name of the command defined in the package manifest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Count + +Specify the maximum number of results to return. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id + +Specify the package identifier to search for. By default, the command does a case-insensitive substring match. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MatchOption + +Specify matching logic used for search. The parameter accepts the following values: + +- `Equals` +- `EqualsCaseInsensitive` +- `StartsWithCaseInsensitive` +- `ContainsCaseInsensitive` + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption +Parameter Sets: (All) +Aliases: +Accepted values: Equals, EqualsCaseInsensitive, StartsWithCaseInsensitive, ContainsCaseInsensitive + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Moniker + +Specify the moniker of the package you are searching for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name + +Specify the name of the package to search for. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Query + +Specify one or more strings to search for. By default, the command searches all configured sources. +The command compares the value provided to the following package manifest properties: +- `PackageIdentifier` +- `PackageName` +- `Moniker` +- `Tags` + +The command does a case-insensitive substring comparison of these properties. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Source + +Specify the name of the WinGet source to search. The most common sources are `msstore` and `winget`. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag + +Specify a package tag to search for. + +```yaml +Type: System.String +Parameter Sets: (All) +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.UInt32 + +### System.String[] + +### Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption + +## OUTPUTS + +### Microsoft.WinGet.Client.Engine.PSObjects.PSFoundCatalogPackage + +## NOTES + +## RELATED LINKS + +[Export-WinGetPackage](Export-WinGetPackage.md) + +[Install-WinGetPackage](Install-WinGetPackage.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md new file mode 100644 index 0000000000..6c8342b81e --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md @@ -0,0 +1,228 @@ +--- +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: Get-WinGetPackage +--- + +# Get-WinGetPackage + +## SYNOPSIS +Lists installed packages. + +## SYNTAX + +``` +Get-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id ] [-Name ] + [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] + [] +``` + +## DESCRIPTION + +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. + +## EXAMPLES + +### Example 1: Default example + +```powershell +Get-WinGetPackage +``` + +This example shows how to list all packages installed on your system. + +## PARAMETERS + +### -Command + +Specify the name of the command defined in the package manifest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Count + +Limits the number of items returned by the command. + +```yaml +Type: System.UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id + +Specify the package identifier for the package you want to list. By default, the command does a +case-insensitive substring comparison on the package identifier. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MatchOption + +Specify matching logic used for search. The parameter accepts the following values: + +- `Equals` +- `EqualsCaseInsensitive` +- `StartsWithCaseInsensitive` +- `ContainsCaseInsensitive` + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption +Parameter Sets: (All) +Aliases: +Accepted values: Equals, EqualsCaseInsensitive, StartsWithCaseInsensitive, ContainsCaseInsensitive + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Moniker + +Specify the moniker of the package you want to list. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name + +Specify the name of the package to list. By default, the command does a case-insensitive comparison +of the package name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Query + +Specify one or more strings to search for. By default, the command searches all configured sources. +The command compares the value provided to the following package manifest properties: + +- `PackageIdentifier` +- `PackageName` +- `Moniker` +- `Tags` + +The command does a case-insensitive substring comparison of these properties. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Source + +Specify the name of the WinGet source of the package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag + +Specify a package tag to search for. + +```yaml +Type: System.String +Parameter Sets: (All) +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.UInt32 + +### System.String[] + +### Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption + +## OUTPUTS + +### Microsoft.WinGet.Client.Engine.PSObjects.PSInstalledCatalogPackage + +## NOTES + +## RELATED LINKS + +[Uninstall-WinGetPackage](Uninstall-WinGetPackage.md) + +[Update-WinGetPackage](Update-WinGetPackage.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md new file mode 100644 index 0000000000..6c828f7b28 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -0,0 +1,102 @@ +--- +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: Get-WinGetSettings +--- + +# Get-WinGetSettings + +## SYNOPSIS +Gets WinGet configuration settings. + +## SYNTAX + +``` +Get-WinGetSettings [-AsPlainText] [] +``` + +## DESCRIPTION + +This command gets the WinGet configuration settings. The settings include: +- the schema +- administrative settings +- the location of the user settings file +For more information about WinGet settings, see +[WinGet CLI Settings](https://aka.ms/winget-settings). + +## EXAMPLES + +### Example 1 - Display the WinGet configuration settings + +```powershell +Get-WinGetSettings +``` + +```Output + +Name Value +---- ----- +$schema https://aka.ms/winget-settings-export.schema.json +userSettingsFile C:\Users\user1\AppData\Local\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\Local… +adminSettings {[ProxyCommandLineOptions, False], [LocalArchiveMalwareScanOverride, False], [InstallerH… +``` + +### Example 2 - Display the administrative settings in WinGet configuration + +```powershell +Get-WinGetSettings | Select-Object -ExpandProperty adminSettings +``` + +```Output +Name Value +---- ----- +InstallerHashOverride False +ProxyCommandLineOptions False +BypassCertificatePinningForMicrosoftStore False +LocalArchiveMalwareScanOverride False +LocalManifestFiles True +``` + +## PARAMETERS + +### -AsPlainText + +Output results as plain text + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +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.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-WinGetUserSettings](Get-WinGetUserSettings.md) + +[Set-WinGetUserSettings](Set-WinGetUserSettings.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md new file mode 100644 index 0000000000..d0cb84a459 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md @@ -0,0 +1,79 @@ +--- +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: Get-WinGetSource +--- + +# Get-WinGetSource + +## SYNOPSIS +Lists configured WinGet sources. + +## SYNTAX + +``` +Get-WinGetSource [[-Name] ] [] +``` + +## DESCRIPTION + +Lists the configured WinGet sources. + +## EXAMPLES + +### Example 1: List all configured WinGet sources + +```powershell +Get-WinGetSource +``` + +```Output +Name Argument Type +---- -------- ---- +msstore https://storeedgefd.dsx.mp.microsoft.com/v9.0 Microsoft.Rest +winget https://cdn.winget.microsoft.com/cache Microsoft.PreIndexed.Package +``` + +## PARAMETERS + +### -Name + +Specify the name of the WinGet source to be displayed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +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 + +### Microsoft.WinGet.Client.Engine.PSObjects.PSSourceResult + +## NOTES + +## RELATED LINKS + +[Add-WinGetSource](Add-WinGetSource.md) + +[Remove-WinGetSource](Remove-WinGetSource.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md new file mode 100644 index 0000000000..9c6ef88b23 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md @@ -0,0 +1,58 @@ +--- +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: Get-WinGetUserSettings +--- + +# Get-WinGetUserSettings + +## SYNOPSIS +Gets user settings for WinGet. + +## SYNTAX + +``` +Get-WinGetUserSettings [] +``` + +## DESCRIPTION + +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 changed a user setting, for example, using the `Set-WinGetUserSettings` command. + +## EXAMPLES + +### Example 1: Get the WinGet settings for the current user + +```powershell +Get-WinGetUserSettings +``` + +## PARAMETERS + +### 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 + +### None + +## OUTPUTS + +### System.Collections.Hashtable + +## NOTES + +## RELATED LINKS + +[Get-WinGetSettings](Get-WinGetSettings.md) + +[Set-WinGetUserSettings](Set-WinGetUserSettings.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md new file mode 100644 index 0000000000..dd216df198 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md @@ -0,0 +1,54 @@ +--- +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: Get-WinGetVersion +--- + +# Get-WinGetVersion + +## SYNOPSIS +Gets the installed version of WinGet. + +## SYNTAX + +``` +Get-WinGetVersion [] +``` + +## DESCRIPTION + +Gets the installed version of WinGet. + +## EXAMPLES + +### Example 1: Default example + +```powershell +Get-WinGetVersion +``` + +Gets the installed version of WinGet. + +## PARAMETERS + +### 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 + +### None + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md new file mode 100644 index 0000000000..037d872cd4 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -0,0 +1,542 @@ +--- +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: Install-WinGetPackage +--- + +# Install-WinGetPackage + +## SYNOPSIS +Installs a WinGet Package. + +## SYNTAX + +### FoundSet (Default) + +``` +Install-WinGetPackage [-Mode ] [-Override ] [-Custom ] + [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] + [-Architecture ] [-InstallerType ] [-Locale ] + [-Scope ] [-SkipDependencies] [-Version ] [-Id ] [-Name ] + [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] + [-WhatIf] [-Confirm] [] +``` + +### GivenSet + +``` +Install-WinGetPackage [-Mode ] [-Override ] [-Custom ] + [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] + [-Architecture ] [-InstallerType ] [-Locale ] + [-Scope ] [-SkipDependencies] [[-PSCatalogPackage] ] + [-Version ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This command installs a WinGet package from a configured source. 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. +Wildcards are not supported. You can change the search behavior using the **MatchOption** parameter. + +## EXAMPLES + +### Example 1: Install a package using a query + +```powershell +Install-WinGetPackage Microsoft.PowerShell +``` + +This example show how to install a package using a query. The **Query** parameter is positional, so +you don't need to include the parameter name before the query string. + +### Example 2: Install a package by Id + +```powershell +Install-WinGetPackage -Id Microsoft.PowerShell +``` + +This example shows how to install a package by the specifying the package identifier. +If the package identifier is available from more than one source, you must provide additional search +criteria to select a specific instance of the package. + +> **If more than one source is configured with the same package identifier, the user must disambiguate** + +### Example 3: Install a package by Name + +```powershell +Install-WinGetPackage -Name "PowerToys (Preview)" +``` + +This example shows how to install a package by specifying the package name. + +### Example 4: Install a specific version of a package + +```powershell +Install-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 +``` + +This example shows how to install a specific version of a package using a query. The command does a +query search for packages matching `Microsoft.PowerShell`. The results of the search a limited to +matches with the version of `7.4.4.0`. + +## PARAMETERS + +### -AllowHashMismatch + +Allows you to download package even when the SHA256 hash for an installer or a dependency does not +match the SHA256 hash in the WinGet package manifest. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Architecture + +Specify the processor architecture for the WinGet package installer. + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture +Parameter Sets: (All) +Aliases: +Accepted values: Default, X86, Arm, X64, Arm64 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Custom + +Use this parameter to pass additional arguments to the installer. The parameter takes a single string value. To add 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 is added to the arguments defined in the package manifest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force + +Force the installer to run even when other checks WinGet would perform would prevent this action. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Header + +Custom value to be passed via HTTP header to WinGet REST sources. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id + +Specify the package identifier to search for. The command does a case-insensitive full text match, +rather than a substring match. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstallerType + +A package may contain multiple installer types. Use this parameter to select the installer you want +to use. The parameter accepts the following values: +- `Default` +- `Inno` +- `Wix` +- `Msi` +- `Nullsoft` +- `Zip` +- `Msix` +- `Exe` +- `Burn` +- `MSStore` +- `Portable` + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType +Parameter Sets: (All) +Aliases: +Accepted values: Default, Inno, Wix, Msi, Nullsoft, Zip, Msix, Exe, Burn, MSStore, Portable + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Locale + +Specify the locale of the installer package. The locale must provided in the BCP 47 format, such as +`en-US`. For more information, see +[Standard locale names](/globalization/locale/standard-locale-names). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location + +Specify the file path where you want the packed to be installed. The installer must be able to +support alternate install locations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Log + +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`. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MatchOption + +Specify the match option for a WinGet package query. This parameter accepts the following values: +- `Equals` +- `EqualsCaseInsensitive` +- `StartsWithCaseInsensitive` +- `ContainsCaseInsensitive` + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption +Parameter Sets: FoundSet +Aliases: +Accepted values: Equals, EqualsCaseInsensitive, StartsWithCaseInsensitive, ContainsCaseInsensitive + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Mode + +Specify the output mode for the installer. The parameter accepts the following values: +- `Default` +- `Silent` +- `Interactive` + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallMode +Parameter Sets: (All) +Aliases: +Accepted values: Default, Silent, Interactive + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Moniker + +Specify the moniker of the WinGet package to install. For example, the moniker for the +Microsoft.PowerShell package is `pwsh`. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name + +Specify the name of the package to be installed. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Override + +Use this parameter to override the existing arguments passed to the installer. The parameter takes a single string value. To add 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 specified in the package manifest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PSCatalogPackage + +Provide **PSCatalogPackage** object. You can get a **PSCatalogPackage** object by using the +`Find-WinGetPackage` command. + +```yaml +Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage +Parameter Sets: GivenSet +Aliases: InputObject + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Query + +Specify one or more strings to search for. By default, the command searches all configured sources. +The command compares the value provided to the following package manifest properties: + - `PackageIdentifier` + - `PackageName` + - `Moniker` + - `Tags` + +The command does a case-insensitive substring comparison of these properties. + +```yaml +Type: System.String[] +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope + +Specify WinGet package installer scope. The parameter accepts the following values: + +- `Any` +- `User` +- `System` +- `UserOrUnknown` +- `SystemOrUnknown` + +> [!NOTE] +> The installer scope must be available in the WinGet package manifest. + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope +Parameter Sets: (All) +Aliases: +Accepted values: Any, User, System, UserOrUnknown, SystemOrUnknown + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipDependencies + +Specifies that the command shouldn't install the WinGet package dependencies. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Source + +Specify the name of the WinGet source from which the package should be installed. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version + +Specify the version of the package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### Microsoft.WinGet.Client.PSObjects.PSPackageInstallMode + +### System.String + +### System.Management.Automation.SwitchParameter + +### Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture + +### Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType + +### Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope + +### Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage + +### System.String[] + +### Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption + +## OUTPUTS + +### Microsoft.WinGet.Client.Engine.PSObjects.PSInstallResult + +## NOTES + +## RELATED LINKS + +[Find-WinGetPackage](Find-WinGetPackage.md) + +[Update-WinGetPackage](Update-WinGetPackage.md) + +[Uninstall-WinGetPackage](Uninstall-WinGetPackage.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md new file mode 100644 index 0000000000..44689febb5 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -0,0 +1,71 @@ +--- +Module Name: Microsoft.WinGet.Client +ms.date: 08/01/2024 +Module Guid: e11157e2-cd24-4250-83b8-c6654ea4926a +Download Help Link: +Help Version: 1.8.0 +Locale: en-US +title: Microsoft.WinGet.Client Module +--- + +# Microsoft.WinGet.Client Module +## Description +Microsoft WinGet Client Module for the Windows Package Manager + +## Microsoft.WinGet.Client Cmdlets +### [Add-WinGetSource](Add-WinGetSource.md) +Adds a new WinGet source. + +### [Assert-WinGetPackageManager](Assert-WinGetPackageManager.md) +Verifies WinGet is installed properly. + +### [Disable-WinGetSetting](Disable-WinGetSetting.md) +Disables an administrative setting. + +### [Enable-WinGetSetting](Enable-WinGetSetting.md) +Enables WinGet administrative settings. + +### [Export-WinGetPackage](Export-WinGetPackage.md) +Downloads a package. + +### [Find-WinGetPackage](Find-WinGetPackage.md) +Searches configured sources for packages. + +### [Get-WinGetPackage](Get-WinGetPackage.md) +Gets installed packages. + +### [Get-WinGetSettings](Get-WinGetSettings.md) +Gets WinGet settings. + +### [Get-WinGetSource](Get-WinGetSource.md) +Gets configured WinGet sources. + +### [Get-WinGetUserSettings](Get-WinGetUserSettings.md) +Gets user settings for WinGet. + +### [Get-WinGetVersion](Get-WinGetVersion.md) +Gets the installed version of WinGet. + +### [Install-WinGetPackage](Install-WinGetPackage.md) +Install a WinGet Package. + +### [Remove-WinGetSource](Remove-WinGetSource.md) +Removes a configured source. + +### [Repair-WinGetPackageManager](Repair-WinGetPackageManager.md) +Repairs the WinGet client. + +### [Reset-WinGetSource](Reset-WinGetSource.md) +Resets default WinGet sources. + +### [Set-WinGetUserSettings](Set-WinGetUserSettings.md) +Sets WinGet settings. + +### [Test-WinGetUserSettings](Test-WinGetUserSettings.md) +Tests WinGet settings. + +### [Uninstall-WinGetPackage](Uninstall-WinGetPackage.md) +Uninstalls a WinGet Package. + +### [Update-WinGetPackage](Update-WinGetPackage.md) +Updates a WinGet Package. diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md new file mode 100644 index 0000000000..99c85f981c --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md @@ -0,0 +1,75 @@ +--- +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: Remove-WinGetSource +--- + +# Remove-WinGetSource + +## SYNOPSIS +Removes a configured source. + +## SYNTAX + +``` +Remove-WinGetSource -Name [] +``` + +## DESCRIPTION + +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 command must be executed with administrator permissions. + +## EXAMPLES + +### Example 1: Remove a single source by name + +```powershell +Remove-WinGetSource -Name msstore +``` + +The example shows how to remove a WinGet source by name. + +## PARAMETERS + +### -Name + +Specify the name of the source to be removed. + +```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 +``` + +### 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 + +[Add-WinGetSource](Add-WinGetSource.md) + +[Reset-WinGetSource](Reset-WinGetSource.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md new file mode 100644 index 0000000000..b0f6e28a69 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md @@ -0,0 +1,162 @@ +--- +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: Repair-WinGetPackageManager +--- + +# Repair-WinGetPackageManager + +## SYNOPSIS +Repairs the installation of the WinGet client on your computer. + +## SYNTAX + +### IntegrityVersionSet (Default) + +``` +Repair-WinGetPackageManager [-AllUsers] [-Force] [-Version ] [] +``` + +### IntegrityLatestSet + +``` +Repair-WinGetPackageManager [-AllUsers] [-Force] [-Latest] [-IncludePreRelease] + [] +``` + +## DESCRIPTION + +This command repairs the installation of the WinGet client on your computer by installing the +specified version or the latest version of the client. This command can also install the WinGet +client if it is not already installed on your machine. It ensures that the client is installed +in a working state. + +## EXAMPLES + +### Example 1: Repair the WinGet client + +```powershell +Repair-WinGetPackageManager +``` + +Ensures that the current installed version of WinGet is functioning properly. + +### Example 2: Force install the latest version + +```powershell +Repair-WinGetPackageManager -Latest -Force +``` + +This example shows how to repair they WinGet client by installing the latest version and ensuring +it functions properly. The **Force** parameter shuts down the version that is currently running so +that it can update the application files. + +## PARAMETERS + +### -AllUsers + +Use this parameter to repair the WinGet client for all user accounts on the computer. The command +must run the command with administrator permissions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force + +The **Force** parameter shuts down the version that is currently running so that it can update the +application files. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludePreRelease + +Use this parameter to include prerelease versions of the WinGet client. + +```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 + +Use this parameter to install the latest available version of the WinGet client. + +```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 + +Use this parameter to specify the specific version of the WinGet client to install. + +```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.Management.Automation.SwitchParameter + +### System.String + +## OUTPUTS + +### System.Int32 + +## NOTES + +## RELATED LINKS + +[Get-WinGetVersion](Get-WinGetVersion.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md new file mode 100644 index 0000000000..629cbd3bac --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md @@ -0,0 +1,75 @@ +--- +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: Reset-WinGetSource +--- + +# Reset-WinGetSource + +## SYNOPSIS +Resets default WinGet sources. + +## SYNTAX + +``` +Reset-WinGetSource -Name [] +``` + +## DESCRIPTION + +Resets the current WinGet sources to the default source configurations. This command must be +executed with administrator permissions. + +## EXAMPLES + +### Example 1: Reset the msstore source + +```powershell +Reset-WinGetSource -Name msstore +``` + +This example resets the configured source named 'msstore' by removing it. + +## PARAMETERS + +### -Name + +The name of the 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 +``` + +### 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 + +[Add-WinGetSource](Add-WinGetSource.md) + +[Remove-WinGetSource](Remove-WinGetSource.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md new file mode 100644 index 0000000000..b76a7c4f4a --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md @@ -0,0 +1,126 @@ +--- +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: Set-WinGetUserSettings +--- + +# Set-WinGetUserSettings + +## SYNOPSIS +Sets configuration settings of the WinGet client for the current user. + +## SYNTAX + +``` +Set-WinGetUserSettings -UserSettings [-Merge] [] +``` + +## DESCRIPTION + +This command sets configuration settings of the WinGet client for the current user. The user +settings file doesn't exist until you set a specific value. The file is stored in +`$env:LOCALAPPDATA\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\LocalState\settings.json`. +For more information about WinGet settings, see +[WinGet CLI Settings](https://aka.ms/winget-settings). + +## EXAMPLES + +### Example 1: Set progress bar theme + +```powershell +Set-WinGetUserSettings -UserSettings @{ + visual = @{ + progressBar = 'rainbow' + } +} +``` + +Sets the theme of the progress bar to rainbow. + +### Example 2: Merge install behavior settings + +```powershell +Set-WinGetUserSettings -Merge -UserSettings @{ + installBehavior = @{ + preferences = @{ + scope = 'user' + } + } +} +``` + +Appends the user scope preference setting to the existing WinGet settings configuration. + +### Example 3: Change multiple settings + +```powershell +Set-WinGetUserSettings -UserSettings @{ + visual = @{ + progressBar = 'rainbow' + anonymizeDisplayedPaths = $true + } +} +``` + +## PARAMETERS + +### -Merge + +By default, the command overwrites the current setting with the values provided. Use this parameter +to append the new settings to the existing configuration. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserSettings + +A hashtable containing the key value pairs representing the WinGet settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +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.Collections.Hashtable + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Collections.Hashtable + +## NOTES + +## RELATED LINKS + +[Get-WinGetUserSettings](Get-WinGetUserSettings.md) + +[Test-WinGetUserSettings](Test-WinGetUserSettings.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md new file mode 100644 index 0000000000..fbc0100c95 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md @@ -0,0 +1,114 @@ +--- +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: Test-WinGetUserSettings +--- + +# Test-WinGetUserSettings + +## SYNOPSIS +Tests the current state of WinGet user settings. + +## SYNTAX + +``` +Test-WinGetUserSettings -UserSettings [-IgnoreNotSet] [] +``` + +## DESCRIPTION + +This command tests the current state of WinGet user settings against a provided set of values. + +## EXAMPLES + +### Example 1: Test for exact match + +```powershell +Test-WinGetUserSettings -UserSettings @{ + installBehavior = @{ + preferences = @{ + scope = 'user' + } + } +} +``` + +This example shows how to confirm that your current user settings match specific values. The +command returns `$false` if it is not an exact match. + +### Example 2: Test only progress bar setting + +```powershell +Test-WinGetUserSettings -IgnoreNotSet -UserSettings @{ + visual = @{ + progressBar = 'rainbow' + } +} +``` + +This examples tests whether the progress bar theme is set to `rainbow`. When you use the +**IgnoreNotSet** parameter, the command only tests the provide values and doesn't include other +WinGet settings in the comparison. + +## PARAMETERS + +### -IgnoreNotSet + +When you use the **IgnoreNotSet** parameter, the command only tests the provide values and doesn't +include other WinGet settings in the comparison. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserSettings + +A hashtable containing the key value pairs representing the WinGet settings. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +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.Collections.Hashtable + +### System.Management.Automation.SwitchParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + +[Get-WinGetUserSettings](Get-WinGetUserSettings.md) + +[Set-WinGetUserSettings](Set-WinGetUserSettings.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md new file mode 100644 index 0000000000..91d92f7078 --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -0,0 +1,350 @@ +--- +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: Uninstall-WinGetPackage +--- + +# Uninstall-WinGetPackage + +## SYNOPSIS +Uninstalls a WinGet Package. + +## SYNTAX + +### FoundSet (Default) + +``` +Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ] [-Version ] + [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] + [-MatchOption ] [-WhatIf] [-Confirm] [] +``` + +### GivenSet + +``` +Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ] + [[-PSCatalogPackage] ] [-Version ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION + +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. Wildcards are not supported. You can change the search behavior +using the **MatchOption** parameter. + +## EXAMPLES + +### Example 1: Uninstall a package using a query + +```powershell +Uninstall-WinGetPackage Microsoft.PowerShell +``` + +This example show how to uninstall a package using a query. The **Query** parameter is positional, +so you don't need to include the parameter name before the query string. + +### Example 2: Uninstall a package by Id + +```powershell +Uninstall-WinGetPackage -Id Microsoft.PowerShell +``` + +This example shows how to uninstall a package by the specifying the package identifier. + +If the package identifier is available from more than one source, you must provide additional search +criteria to select a specific instance of the package. + +### Example 3: Uninstall a package by Name + +```powershell +Uninstall-WinGetPackage -Name "PowerToys (Preview)" +``` + +This sample uninstalls the PowerToys package by the specifying the package name. + +### Example 4: Uninstall a specific version of a package + +```powershell +Uninstall-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 +``` + +This example shows how to uninstall a specific version of a package using a query. The command does +a query search for packages matching `Microsoft.PowerShell`. The results of the search a limited to +matches with the version of `7.4.4.0`. + +## PARAMETERS + +### -Force + +Force the uninstall to run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id + +Specify the package identifier to search for. By default, the command does a case-insensitive +substring match. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Log + +Specify the location for the uninstaller log. The value can be a fully-qualified or relative path and must include the file name. For example: `$env:TEMP\package.log`. + +> **Note: Not all uninstallers support this option.** + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MatchOption + +Specify the match option for a WinGet package query. This parameter accepts the following values: + +- `Equals` +- `EqualsCaseInsensitive` +- `StartsWithCaseInsensitive` +- `ContainsCaseInsensitive` + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption +Parameter Sets: FoundSet +Aliases: +Accepted values: Equals, EqualsCaseInsensitive, StartsWithCaseInsensitive, ContainsCaseInsensitive + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Mode + +Specify the output mode for the installer. The parameter accepts the following values: + +- `Default` +- `Silent` +- `Interactive` + +> [!NOTE] +> Not all uninstallers support all modes. + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageUninstallMode +Parameter Sets: (All) +Aliases: +Accepted values: Default, Silent, Interactive + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Moniker + +Specify the moniker of the WinGet package to download. For example, the moniker for the +Microsoft.PowerShell package is `pwsh`. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name + +Specify the name of the WinGet package name. The name contains space, you must enclose the name in +quotes. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PSCatalogPackage + +Provide **PSCatalogPackage** object. You can get a **PSCatalogPackage** object by using the +`Find-WinGetPackage` or `Get-WingetPackage` commands. + +```yaml +Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage +Parameter Sets: GivenSet +Aliases: InputObject + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Query + +Specify one or more strings to search for. By default, the command searches all configured sources. +Wildcards are not supported. The command compares the value provided to the following package +manifest properties: + + - `PackageIdentifier` + - `PackageName` + - `Moniker` + - `Tags` + +The command does a case-insensitive substring comparison of these properties. + +```yaml +Type: System.String[] +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Source + +Specify the name of a configured WinGet source. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version + +Specify the version of the package to be uninstalled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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 + +### Microsoft.WinGet.Client.PSObjects.PSPackageUninstallMode + +### System.Management.Automation.SwitchParameter + +### System.String + +### Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage + +### System.String[] + +### Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption + +## OUTPUTS + +### Microsoft.WinGet.Client.Engine.PSObjects.PSUninstallResult + +## NOTES + +## RELATED LINKS + +[Get-WinGetPackage](Get-WinGetPackage.md) + +[Install-WinGetPackage](Install-WinGetPackage.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md new file mode 100644 index 0000000000..c222dfcbcd --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -0,0 +1,571 @@ +--- +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: Update-WinGetPackage +--- + +# Update-WinGetPackage + +## SYNOPSIS +Installs a newer version of a previously installed WinGet package. + +## SYNTAX + +### FoundSet (Default) + +``` +Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ] [-Custom ] + [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] + [-Architecture ] [-InstallerType ] [-Locale ] + [-Scope ] [-SkipDependencies] [-Version ] [-Id ] [-Name ] + [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] + [-WhatIf] [-Confirm] [] +``` + +### GivenSet + +``` +Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ] [-Custom ] + [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] + [-Architecture ] [-InstallerType ] [-Locale ] + [-Scope ] [-SkipDependencies] [[-PSCatalogPackage] ] + [-Version ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +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. Wildcards are not supported. You can change the search behavior using the **MatchOption** parameter. + +## EXAMPLES + +### Example 1: Update a package using a query + +```powershell +Update-WinGetPackage Microsoft.PowerShell +``` + +This example show how to update a package using a query. The **Query** parameter is positional, so +you don't need to include the parameter name before the query string. + +### Example 2: Update a package by Id + +```powershell +Update-WinGetPackage -Id Microsoft.PowerShell +``` + +This example shows how to update a package by the specifying the package identifier. + +If the package identifier is available from more than one source, you must provide additional search +criteria to select a specific instance of the package. + +### Example 3: Update a package by Name + +```powershell +Update-WinGetPackage -Name "PowerToys (Preview)" +``` + +This sample updates the PowerToys package by the specifying the package name. + +### Example 4: Update to a specific version of a package + +```powershell +Update-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 +``` + +This example shows how to update a specific version of a package using a query. The command does a +query search for packages matching `Microsoft.PowerShell`. The results of the search a limited to +matches with the version of `7.4.4.0`. + +## PARAMETERS + +### -AllowHashMismatch + +Allows you to download package even when the SHA256 hash for an installer or a dependency does not +match the SHA256 hash in the WinGet package manifest. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Architecture + +Specify the processor architecture for the WinGet package installer. The parameter accepts the +following values: + +- `Default` +- `X86` +- `Arm` +- `X64` +- `Arm64` + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture +Parameter Sets: (All) +Aliases: +Accepted values: Default, X86, Arm, X64, Arm64 + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Custom + +Use this parameter to pass additional arguments to the installer. The parameter takes a single string value. To add 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 is added to the arguments defined in the package manifest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Force + +Force the update to run the installer. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Header + +Specify a custom value in the HTTP header to the REST source. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Id + +Specify the package identifier to search for. By default, the command does a case-insensitive +substring match. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -IncludeUnknown + +Use this parameter to upgrade the package when the installed version is not specified in the +registry. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InstallerType + +A package may contain multiple installer types. Use this parameter to select the installer you want +to use. The parameter accepts the following values: + +- `Default` +- `Inno` +- `Wix` +- `Msi` +- `Nullsoft` +- `Zip` +- `Msix` +- `Exe` +- `Burn` +- `MSStore` +- `Portable` + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType +Parameter Sets: (All) +Aliases: +Accepted values: Default, Inno, Wix, Msi, Nullsoft, Zip, Msix, Exe, Burn, MSStore, Portable + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Locale + +Specify the locale of the installer package. The locale must provided in the BCP 47 format, such as +`en-US`. For more information, see +[Standard locale names](/globalization/locale/standard-locale-names). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Location + +Specify the file path where you want the packed to be installed. The installer must be able to +support alternate install locations. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Log + +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`. + +> **Note: Not all installers support this property.** + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MatchOption + +Specify the match option for a WinGet package query. This parameter accepts the following values: + +- `Equals` +- `EqualsCaseInsensitive` +- `StartsWithCaseInsensitive` +- `ContainsCaseInsensitive` + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption +Parameter Sets: FoundSet +Aliases: +Accepted values: Equals, EqualsCaseInsensitive, StartsWithCaseInsensitive, ContainsCaseInsensitive + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Mode + +Specify the output mode for the installer. The parameter accepts the following values: + +- `Default` +- `Silent` +- `Interactive` + +Not all installers support all modes. + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallMode +Parameter Sets: (All) +Aliases: +Accepted values: Default, Silent, Interactive + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Moniker + +Specify the moniker of the WinGet package to update. For example, the moniker for the +Microsoft.PowerShell package is `pwsh`. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Name + +Specify the name of the package to be updated. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Override + +Use this parameter to override the existing arguments passed to the installer. The parameter takes a single string value. To add 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 specified in the package manifest. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PSCatalogPackage + +Provide **PSCatalogPackage** object. You can get a **PSCatalogPackage** object by using the +`Find-WinGetPackage` or `Get-WinGetPackage` commands. + +```yaml +Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage +Parameter Sets: GivenSet +Aliases: InputObject + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Query + +Specify one or more strings to search for. By default, the command searches all configured sources. +Wildcards are not supported. The command compares the value provided to the following package +manifest properties: + + - `PackageIdentifier` + - `PackageName` + - `Moniker` + - `Tags` + +The command does a case-insensitive substring comparison of these properties. + +```yaml +Type: System.String[] +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Scope + +Specify WinGet package installer scope. The parameter accepts the following values: + +- `Any` +- `User` +- `System` +- `UserOrUnknown` +- `SystemOrUnknown` + +> [!NOTE] +> The installer scope must be available in the WinGet package manifest. + +```yaml +Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope +Parameter Sets: (All) +Aliases: +Accepted values: Any, User, System, UserOrUnknown, SystemOrUnknown + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SkipDependencies + +Specifies that the command shouldn't install the WinGet package dependencies. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Source + +Specify the name of a configured WinGet source. + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Version + +Specify package version. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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.Management.Automation.SwitchParameter + +### Microsoft.WinGet.Client.PSObjects.PSPackageInstallMode + +### System.String + +### Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture + +### Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType + +### Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope + +### Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage + +### System.String[] + +### Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption + +## OUTPUTS + +### Microsoft.WinGet.Client.Engine.PSObjects.PSInstallResult + +## NOTES + +## RELATED LINKS + +[Get-WinGetPackage](Get-WinGetPackage.md) + +[Uninstall-WinGetPackage](Uninstall-WinGetPackage.md) diff --git a/src/PowerShell/Help/markdownlint.yaml b/src/PowerShell/Help/markdownlint.yaml new file mode 100644 index 0000000000..a794811c1f --- /dev/null +++ b/src/PowerShell/Help/markdownlint.yaml @@ -0,0 +1,117 @@ +docsmd.alert: true +docsmd.codesnippet: true +docsmd.column: true +docsmd.image: true +docsmd.moniker: true +docsmd.no-loc: true +docsmd.row: true +docsmd.securelinks: true +docsmd.syntax: true +docsmd.video: true +docsmd.xref: true +docsmd.zone: true + +MD001: true # header-increment +# MD002 # first-header-h1 - Superceded by MD041 +MD003: # header-style + style: atx +MD004: # ul-style + style: dash +MD005: true # list-indent +# MD006 # ul-start-left - Superceded by MD007's start_indented option +MD007: # ul-indent + indent: 2 + start_indented: false +# MD008 # Removed from linter; used to specify indentation for ul +MD009: # no-trailing-spaces + br_spaces: 2 + strict: true +MD010: true # no-hard-tabs +MD011: true # no-reversed-links +MD012: true # no-multiple-blanks +MD013: # line-length + code_block_line_length: 90 + code_blocks: true + heading_line_length: 100 + headings: true + line_length: 100 + stern: true + tables: false +MD014: true # commands-show-output +# MD015 # "Use of non-atx style headers" - Removed from linter, replaced by MD003 +# MD016 # "Use of non-closed-atx style headers" - Removed from linter, replaced by MD003 +# MD017 # "Use of non-setext style headers" - Removed from linter, replaced by MD003 +MD018: true # no-missing-space-atx +MD019: true # no-multiple-space-atx +MD020: true # no-missing-space-closed-atx +MD021: true # no-multiple-space-closed-atx +MD022: true # blanks-around-headers +MD023: true # header-start-left +MD024: # no-duplicate-header + siblings_only: true +MD025: # single-h1 + front_matter_title: '' + level: 1 +MD026: # no-trailing-punctuation + punctuation: '.,;:!。，；：！？' +MD027: true # no-multiple-space-blockquote +MD028: true # no-blanks-blockquote +MD029: # ol-prefix + style: one +MD030: true # list-marker-space +MD031: true # blanks-around-fences +MD032: true # blanks-around-lists +MD033: # no-inline-html + allowed_elements: + - a + - br + - code + - kbd + - li + - properties + - sup + - tags + - ul +MD034: true # no-bare-urls +MD035: # hr-style + style: '---' +MD036: true # no-emphasis-as-header +MD037: true # no-space-in-emphasis +MD038: true # no-space-in-code +MD039: true # no-space-in-links +MD040: false # fenced-code-language +MD041: # first-line-h1 + front_matter_title: '' +MD042: true # no-empty-links +MD043: false # required-headers +MD044: # proper-names + code_blocks: false + names: + - PowerShell + - IntelliSense + - Authenticode + - CentOS + - Contoso + - CoreOS + - Debian + - Ubuntu + - openSUSE + - RHEL + - JavaScript + - .NET + - NuGet + - VS Code + - Newtonsoft +MD045: true # no-alt-text +MD046: # code-block-style + style: fenced +MD047: true # single-trailing-newline +MD048: # code-fence-style + style: backtick +MD049: # emphasis-style + style: underscore +MD050: # strong-style + style: asterisk +MD051: true # link-fragments +MD052: true # reference-links-images +MD053: true # link-image-reference-definitions