From 801e0e399aa2acc93232c32d6bcff44a0c68881a Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Wed, 24 Jul 2024 14:42:01 -0700 Subject: [PATCH 01/55] Add platyPS generated help files Adding the base help files generated by platyPS. --- src/PowerShell/Help/Add-WinGetSource.md | 106 ++++ .../Help/Assert-WinGetPackageManager.md | 114 +++++ src/PowerShell/Help/Disable-WinGetSetting.md | 75 +++ src/PowerShell/Help/Enable-WinGetSetting.md | 75 +++ src/PowerShell/Help/Export-WinGetPackage.md | 348 +++++++++++++ src/PowerShell/Help/Find-WinGetPackage.md | 205 ++++++++ src/PowerShell/Help/Get-WinGetPackage.md | 205 ++++++++ src/PowerShell/Help/Get-WinGetSettings.md | 75 +++ src/PowerShell/Help/Get-WinGetSource.md | 76 +++ src/PowerShell/Help/Get-WinGetUserSettings.md | 61 +++ src/PowerShell/Help/Get-WinGetVersion.md | 61 +++ src/PowerShell/Help/Install-WinGetPackage.md | 443 +++++++++++++++++ .../Help/Microsoft.WinGet.Client.md | 70 +++ src/PowerShell/Help/Remove-WinGetSource.md | 75 +++ .../Help/Repair-WinGetPackageManager.md | 146 ++++++ src/PowerShell/Help/Reset-WinGetSource.md | 75 +++ src/PowerShell/Help/Set-WinGetUserSettings.md | 94 ++++ .../Help/Test-WinGetUserSettings.md | 94 ++++ .../Help/Uninstall-WinGetPackage.md | 280 +++++++++++ src/PowerShell/Help/Update-WinGetPackage.md | 458 ++++++++++++++++++ 20 files changed, 3136 insertions(+) create mode 100644 src/PowerShell/Help/Add-WinGetSource.md create mode 100644 src/PowerShell/Help/Assert-WinGetPackageManager.md create mode 100644 src/PowerShell/Help/Disable-WinGetSetting.md create mode 100644 src/PowerShell/Help/Enable-WinGetSetting.md create mode 100644 src/PowerShell/Help/Export-WinGetPackage.md create mode 100644 src/PowerShell/Help/Find-WinGetPackage.md create mode 100644 src/PowerShell/Help/Get-WinGetPackage.md create mode 100644 src/PowerShell/Help/Get-WinGetSettings.md create mode 100644 src/PowerShell/Help/Get-WinGetSource.md create mode 100644 src/PowerShell/Help/Get-WinGetUserSettings.md create mode 100644 src/PowerShell/Help/Get-WinGetVersion.md create mode 100644 src/PowerShell/Help/Install-WinGetPackage.md create mode 100644 src/PowerShell/Help/Microsoft.WinGet.Client.md create mode 100644 src/PowerShell/Help/Remove-WinGetSource.md create mode 100644 src/PowerShell/Help/Repair-WinGetPackageManager.md create mode 100644 src/PowerShell/Help/Reset-WinGetSource.md create mode 100644 src/PowerShell/Help/Set-WinGetUserSettings.md create mode 100644 src/PowerShell/Help/Test-WinGetUserSettings.md create mode 100644 src/PowerShell/Help/Uninstall-WinGetPackage.md create mode 100644 src/PowerShell/Help/Update-WinGetPackage.md diff --git a/src/PowerShell/Help/Add-WinGetSource.md b/src/PowerShell/Help/Add-WinGetSource.md new file mode 100644 index 0000000000..ea65acc80d --- /dev/null +++ b/src/PowerShell/Help/Add-WinGetSource.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Add-WinGetSource + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Add-WinGetSource -Name -Argument [-Type ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Argument +{{ Fill Argument Description }} + +```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 +{{ Fill Name Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +{{ Fill Type Description }} + +```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, -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 diff --git a/src/PowerShell/Help/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Assert-WinGetPackageManager.md new file mode 100644 index 0000000000..75b655736c --- /dev/null +++ b/src/PowerShell/Help/Assert-WinGetPackageManager.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Assert-WinGetPackageManager + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### IntegrityVersionSet (Default) +``` +Assert-WinGetPackageManager [-Version ] [-ProgressAction ] [] +``` + +### IntegrityLatestSet +``` +Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -IncludePreRelease +{{ Fill IncludePreRelease Description }} + +```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 +{{ Fill Latest Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +{{ Fill Version Description }} + +```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, -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 diff --git a/src/PowerShell/Help/Disable-WinGetSetting.md b/src/PowerShell/Help/Disable-WinGetSetting.md new file mode 100644 index 0000000000..b7d9e73944 --- /dev/null +++ b/src/PowerShell/Help/Disable-WinGetSetting.md @@ -0,0 +1,75 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Disable-WinGetSetting + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Disable-WinGetSetting [-Name] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +{{ Fill Name Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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, -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 diff --git a/src/PowerShell/Help/Enable-WinGetSetting.md b/src/PowerShell/Help/Enable-WinGetSetting.md new file mode 100644 index 0000000000..679c0f480f --- /dev/null +++ b/src/PowerShell/Help/Enable-WinGetSetting.md @@ -0,0 +1,75 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Enable-WinGetSetting + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Enable-WinGetSetting [-Name] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +{{ Fill Name Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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, -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 diff --git a/src/PowerShell/Help/Export-WinGetPackage.md b/src/PowerShell/Help/Export-WinGetPackage.md new file mode 100644 index 0000000000..16fb7a34db --- /dev/null +++ b/src/PowerShell/Help/Export-WinGetPackage.md @@ -0,0 +1,348 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Export-WinGetPackage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### FoundSet (Default) +``` +Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] + [-Architecture ] [-InstallerType ] [-Locale ] + [-Scope ] [-SkipDependencies] [-Version ] [-Id ] [-Name ] + [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +### GivenSet +``` +Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] + [-Architecture ] [-InstallerType ] [-Locale ] + [-Scope ] [-SkipDependencies] [[-PSCatalogPackage] ] + [-Version ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AllowHashMismatch +{{ Fill AllowHashMismatch Description }} + +```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 +{{ Fill Architecture Description }} + +```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 +{{ Fill DownloadDirectory Description }} + +```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 +{{ Fill Id Description }} + +```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 +{{ Fill InstallerType Description }} + +```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 +{{ Fill Locale Description }} + +```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 +{{ Fill MatchOption Description }} + +```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 +{{ Fill Moniker Description }} + +```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 +{{ Fill Name Description }} + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSCatalogPackage +{{ Fill PSCatalogPackage Description }} + +```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 +{{ Fill Query Description }} + +```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 +{{ Fill Scope Description }} + +```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 +{{ Fill SkipDependencies Description }} + +```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 +{{ Fill Source Description }} + +```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 +{{ Fill Version Description }} + +```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 is not 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, -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 diff --git a/src/PowerShell/Help/Find-WinGetPackage.md b/src/PowerShell/Help/Find-WinGetPackage.md new file mode 100644 index 0000000000..47a29c1d10 --- /dev/null +++ b/src/PowerShell/Help/Find-WinGetPackage.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Find-WinGetPackage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Find-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id ] [-Name ] + [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Command +{{ Fill Command Description }} + +```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 +{{ Fill Count Description }} + +```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 +{{ Fill Id Description }} + +```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 +{{ Fill MatchOption Description }} + +```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 +{{ Fill Moniker Description }} + +```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 +{{ Fill Name Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +{{ Fill Query Description }} + +```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 +{{ Fill Source Description }} + +```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 +{{ Fill Tag Description }} + +```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, -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 diff --git a/src/PowerShell/Help/Get-WinGetPackage.md b/src/PowerShell/Help/Get-WinGetPackage.md new file mode 100644 index 0000000000..4f94874167 --- /dev/null +++ b/src/PowerShell/Help/Get-WinGetPackage.md @@ -0,0 +1,205 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Get-WinGetPackage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id ] [-Name ] + [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Command +{{ Fill Command Description }} + +```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 +{{ Fill Count Description }} + +```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 +{{ Fill Id Description }} + +```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 +{{ Fill MatchOption Description }} + +```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 +{{ Fill Moniker Description }} + +```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 +{{ Fill Name Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Query +{{ Fill Query Description }} + +```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 +{{ Fill Source Description }} + +```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 +{{ Fill Tag Description }} + +```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, -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 diff --git a/src/PowerShell/Help/Get-WinGetSettings.md b/src/PowerShell/Help/Get-WinGetSettings.md new file mode 100644 index 0000000000..dfd04f8eb2 --- /dev/null +++ b/src/PowerShell/Help/Get-WinGetSettings.md @@ -0,0 +1,75 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Get-WinGetSettings + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-WinGetSettings [-AsPlainText] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AsPlainText +{{ Fill AsPlainText Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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, -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 diff --git a/src/PowerShell/Help/Get-WinGetSource.md b/src/PowerShell/Help/Get-WinGetSource.md new file mode 100644 index 0000000000..2da3bcf1bc --- /dev/null +++ b/src/PowerShell/Help/Get-WinGetSource.md @@ -0,0 +1,76 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Get-WinGetSource + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-WinGetSource [[-Name] ] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +{{ Fill Name Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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, -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 diff --git a/src/PowerShell/Help/Get-WinGetUserSettings.md b/src/PowerShell/Help/Get-WinGetUserSettings.md new file mode 100644 index 0000000000..f316d760c6 --- /dev/null +++ b/src/PowerShell/Help/Get-WinGetUserSettings.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Get-WinGetUserSettings + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-WinGetUserSettings [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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, -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 diff --git a/src/PowerShell/Help/Get-WinGetVersion.md b/src/PowerShell/Help/Get-WinGetVersion.md new file mode 100644 index 0000000000..0651e0819f --- /dev/null +++ b/src/PowerShell/Help/Get-WinGetVersion.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Get-WinGetVersion + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-WinGetVersion [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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, -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/Install-WinGetPackage.md b/src/PowerShell/Help/Install-WinGetPackage.md new file mode 100644 index 0000000000..68619d0ba8 --- /dev/null +++ b/src/PowerShell/Help/Install-WinGetPackage.md @@ -0,0 +1,443 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Install-WinGetPackage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## 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 ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +### GivenSet +``` +Install-WinGetPackage [-Mode ] [-Override ] [-Custom ] + [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] + [-Architecture ] [-InstallerType ] [-Locale ] + [-Scope ] [-SkipDependencies] [[-PSCatalogPackage] ] + [-Version ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AllowHashMismatch +{{ Fill AllowHashMismatch Description }} + +```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 +{{ Fill Architecture Description }} + +```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 +{{ Fill Custom Description }} + +```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 +{{ Fill Force Description }} + +```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 +{{ Fill Header Description }} + +```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 +{{ Fill Id Description }} + +```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 +{{ Fill InstallerType Description }} + +```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 +{{ Fill Locale Description }} + +```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 +{{ Fill Location Description }} + +```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 +{{ Fill Log Description }} + +```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 +{{ Fill MatchOption Description }} + +```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 +{{ Fill Mode Description }} + +```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 +{{ Fill Moniker Description }} + +```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 +{{ Fill Name Description }} + +```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 +{{ Fill Override Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSCatalogPackage +{{ Fill PSCatalogPackage Description }} + +```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 +{{ Fill Query Description }} + +```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 +{{ Fill Scope Description }} + +```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 +{{ Fill SkipDependencies Description }} + +```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 +{{ Fill Source Description }} + +```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 +{{ Fill Version Description }} + +```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 is not 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, -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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client.md new file mode 100644 index 0000000000..1c795e625e --- /dev/null +++ b/src/PowerShell/Help/Microsoft.WinGet.Client.md @@ -0,0 +1,70 @@ +--- +Module Name: Microsoft.WinGet.Client +Module Guid: e11157e2-cd24-4250-83b8-c6654ea4926a +Download Help Link: {{ Update Download Link }} +Help Version: {{ Please enter version of help manually (X.X.X.X) format }} +Locale: en-US +--- + +# Microsoft.WinGet.Client Module +## Description +{{ Fill in the Description }} + +## Microsoft.WinGet.Client Cmdlets +### [Add-WinGetSource](Add-WinGetSource.md) +{{ Fill in the Description }} + +### [Assert-WinGetPackageManager](Assert-WinGetPackageManager.md) +{{ Fill in the Description }} + +### [Disable-WinGetSetting](Disable-WinGetSetting.md) +{{ Fill in the Description }} + +### [Enable-WinGetSetting](Enable-WinGetSetting.md) +{{ Fill in the Description }} + +### [Export-WinGetPackage](Export-WinGetPackage.md) +{{ Fill in the Description }} + +### [Find-WinGetPackage](Find-WinGetPackage.md) +{{ Fill in the Description }} + +### [Get-WinGetPackage](Get-WinGetPackage.md) +{{ Fill in the Description }} + +### [Get-WinGetSettings](Get-WinGetSettings.md) +{{ Fill in the Description }} + +### [Get-WinGetSource](Get-WinGetSource.md) +{{ Fill in the Description }} + +### [Get-WinGetUserSettings](Get-WinGetUserSettings.md) +{{ Fill in the Description }} + +### [Get-WinGetVersion](Get-WinGetVersion.md) +{{ Fill in the Description }} + +### [Install-WinGetPackage](Install-WinGetPackage.md) +{{ Fill in the Description }} + +### [Remove-WinGetSource](Remove-WinGetSource.md) +{{ Fill in the Description }} + +### [Repair-WinGetPackageManager](Repair-WinGetPackageManager.md) +{{ Fill in the Description }} + +### [Reset-WinGetSource](Reset-WinGetSource.md) +{{ Fill in the Description }} + +### [Set-WinGetUserSettings](Set-WinGetUserSettings.md) +{{ Fill in the Description }} + +### [Test-WinGetUserSettings](Test-WinGetUserSettings.md) +{{ Fill in the Description }} + +### [Uninstall-WinGetPackage](Uninstall-WinGetPackage.md) +{{ Fill in the Description }} + +### [Update-WinGetPackage](Update-WinGetPackage.md) +{{ Fill in the Description }} + diff --git a/src/PowerShell/Help/Remove-WinGetSource.md b/src/PowerShell/Help/Remove-WinGetSource.md new file mode 100644 index 0000000000..540611da1c --- /dev/null +++ b/src/PowerShell/Help/Remove-WinGetSource.md @@ -0,0 +1,75 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Remove-WinGetSource + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-WinGetSource -Name [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +{{ Fill Name Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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, -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 diff --git a/src/PowerShell/Help/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Repair-WinGetPackageManager.md new file mode 100644 index 0000000000..246619551b --- /dev/null +++ b/src/PowerShell/Help/Repair-WinGetPackageManager.md @@ -0,0 +1,146 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Repair-WinGetPackageManager + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### IntegrityVersionSet (Default) +``` +Repair-WinGetPackageManager [-AllUsers] [-Force] [-Version ] [-ProgressAction ] + [] +``` + +### IntegrityLatestSet +``` +Repair-WinGetPackageManager [-AllUsers] [-Force] [-Latest] [-IncludePreRelease] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AllUsers +{{ Fill AllUsers Description }} + +```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 +{{ Fill Force Description }} + +```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 +{{ Fill IncludePreRelease Description }} + +```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 +{{ Fill Latest Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +{{ Fill Version Description }} + +```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, -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 diff --git a/src/PowerShell/Help/Reset-WinGetSource.md b/src/PowerShell/Help/Reset-WinGetSource.md new file mode 100644 index 0000000000..d52a4c9724 --- /dev/null +++ b/src/PowerShell/Help/Reset-WinGetSource.md @@ -0,0 +1,75 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Reset-WinGetSource + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Reset-WinGetSource -Name [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +{{ Fill Name Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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, -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 diff --git a/src/PowerShell/Help/Set-WinGetUserSettings.md b/src/PowerShell/Help/Set-WinGetUserSettings.md new file mode 100644 index 0000000000..9ee7e32d0d --- /dev/null +++ b/src/PowerShell/Help/Set-WinGetUserSettings.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Set-WinGetUserSettings + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-WinGetUserSettings -UserSettings [-Merge] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Merge +{{ Fill Merge Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSettings +{{ Fill UserSettings Description }} + +```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, -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 diff --git a/src/PowerShell/Help/Test-WinGetUserSettings.md b/src/PowerShell/Help/Test-WinGetUserSettings.md new file mode 100644 index 0000000000..ea44982e34 --- /dev/null +++ b/src/PowerShell/Help/Test-WinGetUserSettings.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Test-WinGetUserSettings + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Test-WinGetUserSettings -UserSettings [-IgnoreNotSet] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -IgnoreNotSet +{{ Fill IgnoreNotSet Description }} + +```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 +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSettings +{{ Fill UserSettings Description }} + +```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, -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 diff --git a/src/PowerShell/Help/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Uninstall-WinGetPackage.md new file mode 100644 index 0000000000..a79dc6db0f --- /dev/null +++ b/src/PowerShell/Help/Uninstall-WinGetPackage.md @@ -0,0 +1,280 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Uninstall-WinGetPackage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### FoundSet (Default) +``` +Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ] [-Version ] + [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] + [-MatchOption ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +### GivenSet +``` +Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ] + [[-PSCatalogPackage] ] [-Version ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Force +{{ Fill Force Description }} + +```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 +{{ Fill Id Description }} + +```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 +{{ Fill Log Description }} + +```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 +{{ Fill MatchOption Description }} + +```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 +{{ Fill Mode Description }} + +```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 +{{ Fill Moniker Description }} + +```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 +{{ Fill Name Description }} + +```yaml +Type: System.String +Parameter Sets: FoundSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSCatalogPackage +{{ Fill PSCatalogPackage Description }} + +```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 +{{ Fill Query Description }} + +```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 +{{ Fill Source Description }} + +```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 +{{ Fill Version Description }} + +```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 is not 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, -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 diff --git a/src/PowerShell/Help/Update-WinGetPackage.md b/src/PowerShell/Help/Update-WinGetPackage.md new file mode 100644 index 0000000000..cc066fb3d2 --- /dev/null +++ b/src/PowerShell/Help/Update-WinGetPackage.md @@ -0,0 +1,458 @@ +--- +external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml +Module Name: Microsoft.WinGet.Client +online version: +schema: 2.0.0 +--- + +# Update-WinGetPackage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## 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 ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +### GivenSet +``` +Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ] [-Custom ] + [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] + [-Architecture ] [-InstallerType ] [-Locale ] + [-Scope ] [-SkipDependencies] [[-PSCatalogPackage] ] + [-Version ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AllowHashMismatch +{{ Fill AllowHashMismatch Description }} + +```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 +{{ Fill Architecture Description }} + +```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 +{{ Fill Custom Description }} + +```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 +{{ Fill Force Description }} + +```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 +{{ Fill Header Description }} + +```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 +{{ Fill Id Description }} + +```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 +{{ Fill IncludeUnknown Description }} + +```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 +{{ Fill InstallerType Description }} + +```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 +{{ Fill Locale Description }} + +```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 +{{ Fill Location Description }} + +```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 +{{ Fill Log Description }} + +```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 +{{ Fill MatchOption Description }} + +```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 +{{ Fill Mode Description }} + +```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 +{{ Fill Moniker Description }} + +```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 +{{ Fill Name Description }} + +```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 +{{ Fill Override Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PSCatalogPackage +{{ Fill PSCatalogPackage Description }} + +```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 +{{ Fill Query Description }} + +```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 +{{ Fill Scope Description }} + +```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 +{{ Fill SkipDependencies Description }} + +```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 +{{ Fill Source Description }} + +```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 +{{ Fill Version Description }} + +```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 is not 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, -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 From 22e095aeebd67772f6321b49ec3a6c9eb4688b2f Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Wed, 24 Jul 2024 14:44:41 -0700 Subject: [PATCH 02/55] Move files to Microsoft.WinGet.Client --- .../Help/{ => Microsoft.WinGet.Client}/Add-WinGetSource.md | 0 .../{ => Microsoft.WinGet.Client}/Assert-WinGetPackageManager.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Disable-WinGetSetting.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Enable-WinGetSetting.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Export-WinGetPackage.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Find-WinGetPackage.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Get-WinGetPackage.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Get-WinGetSettings.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Get-WinGetSource.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Get-WinGetUserSettings.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Get-WinGetVersion.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Install-WinGetPackage.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Microsoft.WinGet.Client.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Remove-WinGetSource.md | 0 .../{ => Microsoft.WinGet.Client}/Repair-WinGetPackageManager.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Reset-WinGetSource.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Set-WinGetUserSettings.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Test-WinGetUserSettings.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Uninstall-WinGetPackage.md | 0 .../Help/{ => Microsoft.WinGet.Client}/Update-WinGetPackage.md | 0 20 files changed, 0 insertions(+), 0 deletions(-) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Add-WinGetSource.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Assert-WinGetPackageManager.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Disable-WinGetSetting.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Enable-WinGetSetting.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Export-WinGetPackage.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Find-WinGetPackage.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Get-WinGetPackage.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Get-WinGetSettings.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Get-WinGetSource.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Get-WinGetUserSettings.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Get-WinGetVersion.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Install-WinGetPackage.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Microsoft.WinGet.Client.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Remove-WinGetSource.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Repair-WinGetPackageManager.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Reset-WinGetSource.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Set-WinGetUserSettings.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Test-WinGetUserSettings.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Uninstall-WinGetPackage.md (100%) rename src/PowerShell/Help/{ => Microsoft.WinGet.Client}/Update-WinGetPackage.md (100%) diff --git a/src/PowerShell/Help/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md similarity index 100% rename from src/PowerShell/Help/Add-WinGetSource.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md diff --git a/src/PowerShell/Help/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md similarity index 100% rename from src/PowerShell/Help/Assert-WinGetPackageManager.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md diff --git a/src/PowerShell/Help/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md similarity index 100% rename from src/PowerShell/Help/Disable-WinGetSetting.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md diff --git a/src/PowerShell/Help/Enable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md similarity index 100% rename from src/PowerShell/Help/Enable-WinGetSetting.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md diff --git a/src/PowerShell/Help/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md similarity index 100% rename from src/PowerShell/Help/Export-WinGetPackage.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md diff --git a/src/PowerShell/Help/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md similarity index 100% rename from src/PowerShell/Help/Find-WinGetPackage.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md diff --git a/src/PowerShell/Help/Get-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md similarity index 100% rename from src/PowerShell/Help/Get-WinGetPackage.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md diff --git a/src/PowerShell/Help/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md similarity index 100% rename from src/PowerShell/Help/Get-WinGetSettings.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md diff --git a/src/PowerShell/Help/Get-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md similarity index 100% rename from src/PowerShell/Help/Get-WinGetSource.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md diff --git a/src/PowerShell/Help/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md similarity index 100% rename from src/PowerShell/Help/Get-WinGetUserSettings.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md diff --git a/src/PowerShell/Help/Get-WinGetVersion.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md similarity index 100% rename from src/PowerShell/Help/Get-WinGetVersion.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md diff --git a/src/PowerShell/Help/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md similarity index 100% rename from src/PowerShell/Help/Install-WinGetPackage.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md similarity index 100% rename from src/PowerShell/Help/Microsoft.WinGet.Client.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md diff --git a/src/PowerShell/Help/Remove-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md similarity index 100% rename from src/PowerShell/Help/Remove-WinGetSource.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md diff --git a/src/PowerShell/Help/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md similarity index 100% rename from src/PowerShell/Help/Repair-WinGetPackageManager.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md diff --git a/src/PowerShell/Help/Reset-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md similarity index 100% rename from src/PowerShell/Help/Reset-WinGetSource.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md diff --git a/src/PowerShell/Help/Set-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md similarity index 100% rename from src/PowerShell/Help/Set-WinGetUserSettings.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md diff --git a/src/PowerShell/Help/Test-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md similarity index 100% rename from src/PowerShell/Help/Test-WinGetUserSettings.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md diff --git a/src/PowerShell/Help/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md similarity index 100% rename from src/PowerShell/Help/Uninstall-WinGetPackage.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md diff --git a/src/PowerShell/Help/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md similarity index 100% rename from src/PowerShell/Help/Update-WinGetPackage.md rename to src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md From 17bb1d0dffa43ce47d9b0d5dd313c89d62ccc03d Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 10:40:23 -0700 Subject: [PATCH 03/55] Document Add-WinGetSource --- .../Add-WinGetSource.md | 28 +++++++++++++------ 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index ea65acc80d..dce8fc5e38 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Add-WinGetSource ## SYNOPSIS -{{ Fill in the Synopsis }} +Add a new source ## SYNTAX @@ -18,21 +18,28 @@ Add-WinGetSource -Name -Argument [-Type ] [-ProgressAc ``` ## DESCRIPTION -{{ Fill in the Description }} +Add a new WinGet source. ## EXAMPLES ### Example 1 + +> **This example is illustrative and will not succeed because WinGet will not add a source that does not properly +respond to the WinGet REST API** + +This example adds a new REST based source to WinGet named "mysource" with the root URL https://contoso.com/. + ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Add-WinGetSource -Name mysource -Argument https://contoso.com/ -Type Microsoft.Rest ``` -{{ Add example description here }} - ## PARAMETERS ### -Argument -{{ Fill Argument Description }} + +The URL or UNC of the source. + +> **Before a source can be added, WinGet will verify the URL or UNC is reachable and provides the proper response.** ```yaml Type: System.String @@ -47,7 +54,7 @@ Accept wildcard characters: False ``` ### -Name -{{ Fill Name Description }} +The name to identify the source by. ```yaml Type: System.String @@ -62,7 +69,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -77,7 +87,7 @@ Accept wildcard characters: False ``` ### -Type -{{ Fill Type Description }} +Type of the source. Most sources will be "Microsoft.Rest". The WinGet community repository is "Microsoft.PreIndexed.Package". ```yaml Type: System.String From b07eee74af6009492de628ae9742e1906d5e547b Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 10:46:30 -0700 Subject: [PATCH 04/55] fix spelling --- .github/actions/spelling/expect.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 5542cb8220..3999e11124 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -7,6 +7,7 @@ adml admx AFAIK aicli +arning AICLIC AKV allusers @@ -112,6 +113,7 @@ dsc DUPLICATEALIAS dustojnikhummer dvinns +ebug ecfr ecfrbrowse ECustom @@ -330,6 +332,7 @@ omus onefuzz ools oop +ownload OPTOUT OVERLAPPEDWINDOW packageinuse @@ -359,6 +362,7 @@ powershellgallery powertoys processthreads productcode +progra PRODUCTICON proxystub pscustomobject From 84ac4ff8d7997b94d0220d5ac3b2e423410b46bf Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 10:49:07 -0700 Subject: [PATCH 05/55] fix spelling --- .github/actions/spelling/expect.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 3999e11124..59b41b5eb6 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -294,6 +294,7 @@ myinstalldir mylog mysilent mysilentwithprogress +mysource nameof Nami nativehandle @@ -362,7 +363,7 @@ powershellgallery powertoys processthreads productcode -progra +proga PRODUCTICON proxystub pscustomobject From bc86036a289d357917a4710fa7abb0351ddb56a2 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 10:59:48 -0700 Subject: [PATCH 06/55] Add Add-WinGetSource to Microsoft.WinGet.Client.md --- .../Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index 1c795e625e..e63095d6c0 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -12,7 +12,7 @@ Locale: en-US ## Microsoft.WinGet.Client Cmdlets ### [Add-WinGetSource](Add-WinGetSource.md) -{{ Fill in the Description }} +Add a new WinGet source. ### [Assert-WinGetPackageManager](Assert-WinGetPackageManager.md) {{ Fill in the Description }} From 9e27d22d52b24368aa7d767389799453ebf7aba7 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 11:01:56 -0700 Subject: [PATCH 07/55] Modify example 1 Add-WinGetSource --- .../Help/Microsoft.WinGet.Client/Add-WinGetSource.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index dce8fc5e38..cec7deb910 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -24,11 +24,11 @@ Add a new WinGet source. ### Example 1 -> **This example is illustrative and will not succeed because WinGet will not add a source that does not properly -respond to the WinGet REST API** - This example adds a new REST based source to WinGet named "mysource" with the root URL https://contoso.com/. +This example is illustrative and will not succeed because WinGet will not add a source that does not properly +respond to the WinGet REST API. + ```powershell PS C:\> Add-WinGetSource -Name mysource -Argument https://contoso.com/ -Type Microsoft.Rest ``` From 971f11c7913139e729ead7b35f002646ba8b7f56 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 11:28:03 -0700 Subject: [PATCH 08/55] Put example text below example --- .../Help/Microsoft.WinGet.Client/Add-WinGetSource.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index cec7deb910..998fb05f53 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -22,17 +22,16 @@ Add a new WinGet source. ## EXAMPLES -### Example 1 - -This example adds a new REST based source to WinGet named "mysource" with the root URL https://contoso.com/. - -This example is illustrative and will not succeed because WinGet will not add a source that does not properly -respond to the WinGet REST API. +### Example 1: Add new REST source named mysource ```powershell PS C:\> Add-WinGetSource -Name mysource -Argument https://contoso.com/ -Type Microsoft.Rest ``` +This example adds a new REST based source to WinGet named "mysource" with the root URL https://contoso.com/. + +> **This example is illustrative and will not succeed because WinGet will not add a source that does not properly respond to the WinGet REST API** + ## PARAMETERS ### -Argument From 5badcd5e1241d48ad101da59679ccd1123ef7397 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 12:07:10 -0700 Subject: [PATCH 09/55] remove previously acknowledged words that are now absent --- .github/actions/spelling/expect.txt | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 59b41b5eb6..eb9b2b9887 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -32,7 +32,6 @@ ashpatil Ashwini ASwitch ASYNCRTIMP -ata Atest ATL AUrl @@ -45,7 +44,6 @@ BFirst bght bigcatalog BITMAPINFOHEADER -bitspace bkup blargle blockedbypolicy @@ -123,8 +121,6 @@ efileresource EMalicious endregion ENDSESSION -EPester -epth EQU ERRORONEXIT ESource @@ -177,7 +173,6 @@ hmodule Hostx hre hresults -hrow hwnd IARP IAttachment @@ -205,7 +200,6 @@ isable IServer ishelp ISQ -issuetitle ISVs itr IWin @@ -258,7 +252,6 @@ Luffytaro maclachlan malware mapdatafolding -mapview Maxed maxvalue maybenull @@ -286,7 +279,6 @@ MSIXHASH msstore MSZIP mszyml -Mta Mugiwara Multideclaration mycustom @@ -332,7 +324,6 @@ ofile omus onefuzz ools -oop ownload OPTOUT OVERLAPPEDWINDOW @@ -350,7 +341,6 @@ PDWORD Peet peetdev PEGI -PFM pfxpath Pherson pidl @@ -408,7 +398,6 @@ roy runspace runtimeclass ryfu -rzkzqaqjwj sacl SARL SASURL @@ -423,7 +412,6 @@ servercertificate setmetadatabymanifestid SETTINGCHANGE SETTINGMAPPING -sfs sfsclient SHCONTF SHGDN @@ -444,7 +432,6 @@ SPAPI Srinivasan srs startswith -STARTUPINFOW STDMETHODCALLTYPE storeapps storeorigin @@ -464,7 +451,6 @@ tcs TEMPDIRECTORY Templating temppath -testdata testexampleinstaller thiscouldbeapc threehundred @@ -509,7 +495,6 @@ VALUENAMECASE vclib VERSI VERSIE -visualstudiocode vns vsconfig vstest From b94be9ceb580410dc07392be4ff3314a63a4f1e5 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 13:59:48 -0700 Subject: [PATCH 10/55] Update Assert-WinGetPackageManager --- .../Assert-WinGetPackageManager.md | 48 +++++++++++++++---- 1 file changed, 39 insertions(+), 9 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md index 75b655736c..67b178d9c3 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Assert-WinGetPackageManager ## SYNOPSIS -{{ Fill in the Synopsis }} +Verifies WinGet is installed properly. ## SYNTAX @@ -24,21 +24,48 @@ Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [-ProgressAction **This does not ensure the latest version of WinGet is installed. This just verifies the current installed version correlated with the Microsoft.WinGet.Client module is functional.** ## EXAMPLES -### Example 1 +### Example 1: Default usage + +```powershell +PS C:\> Assert-WinGetPackageManager +``` + +If the current version of WinGet is installed correctly this will return without error. + +### Example 2: Check if latest stable version is installed + ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Assert-WinGetPackageManager -Latest ``` -{{ Add example description here }} +If the latest version of WinGet correlated with the Microsoft.WinGet.Client module is installed correctly this will return without error. + +### Example 3: Check if latest preview version is installed + +```powershell +PS C:\> Assert-WinGetPackageManager -IncludePreRelease +``` + +If the a preview version of WinGet correlated with the Microsoft.WinGet.Client module is installed correctly this will return without error. + +### Example 4: Check if specific version is installed + +```powershell +PS C:\> Assert-WinGetPackageManager -Version v1.8.1911 +``` + +If the specified version of WinGet correlated with the Microsoft.WinGet.Client module is installed correctly this will return without error. ## PARAMETERS ### -IncludePreRelease -{{ Fill IncludePreRelease Description }} +Includes preview versions of WinGet ```yaml Type: System.Management.Automation.SwitchParameter @@ -53,7 +80,7 @@ Accept wildcard characters: False ``` ### -Latest -{{ Fill Latest Description }} +Verifies the latest version of WinGet correlated with the Microsoft.WinGet.Client module is installed ```yaml Type: System.Management.Automation.SwitchParameter @@ -68,7 +95,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -83,7 +113,7 @@ Accept wildcard characters: False ``` ### -Version -{{ Fill Version Description }} +Verifies a specific version of WinGet is installed. ```yaml Type: System.String From 670e681cd0d0bef64ffe87931061cc6bc1d99adc Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 14:44:25 -0700 Subject: [PATCH 11/55] Add descriptions to Microsoft.WinGet.Client --- .../Microsoft.WinGet.Client/Microsoft.WinGet.Client.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index e63095d6c0..4a4474431e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -1,21 +1,21 @@ --- Module Name: Microsoft.WinGet.Client Module Guid: e11157e2-cd24-4250-83b8-c6654ea4926a -Download Help Link: {{ Update Download Link }} -Help Version: {{ Please enter version of help manually (X.X.X.X) format }} +Download Help Link: +Help Version: 1.8.0 Locale: en-US --- # Microsoft.WinGet.Client Module ## Description -{{ Fill in the Description }} +Microsoft WinGet Client Module for Windows Package Manager ## Microsoft.WinGet.Client Cmdlets ### [Add-WinGetSource](Add-WinGetSource.md) Add a new WinGet source. ### [Assert-WinGetPackageManager](Assert-WinGetPackageManager.md) -{{ Fill in the Description }} +Verifies WinGet is installed properly. ### [Disable-WinGetSetting](Disable-WinGetSetting.md) {{ Fill in the Description }} From ea7dd5937e6f5bbe38b5f327f6f887c29e1eb983 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 15:32:29 -0700 Subject: [PATCH 12/55] Update Disable-WinGetSetting --- .../Disable-WinGetSetting.md | 31 ++++++++++++++----- .../Microsoft.WinGet.Client.md | 4 +-- 2 files changed, 26 insertions(+), 9 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md index b7d9e73944..ad1f0d8b40 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Disable-WinGetSetting ## SYNOPSIS -{{ Fill in the Synopsis }} +Disables an administrative setting. ## SYNTAX @@ -17,21 +17,31 @@ Disable-WinGetSetting [-Name] [-ProgressAction ] [ {{ Add example code here }} +PS C:\> Disable-WinGetSetting -Name LocalManifestFiles ``` -{{ Add example description here }} +Disable the use of local manifest files. ## PARAMETERS ### -Name -{{ Fill Name Description }} +The name of the administrator setting ```yaml Type: System.String @@ -46,7 +56,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -73,3 +86,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Get-WinGetSettings](Get-WinGetSettings.md) + +[Set-WinGetSetting](Set-WinGetSetting.md) \ No newline at end of file diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index 4a4474431e..f11f636727 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -8,7 +8,7 @@ Locale: en-US # Microsoft.WinGet.Client Module ## Description -Microsoft WinGet Client Module for Windows Package Manager +Microsoft WinGet Client Module for the Windows Package Manager ## Microsoft.WinGet.Client Cmdlets ### [Add-WinGetSource](Add-WinGetSource.md) @@ -18,7 +18,7 @@ Add a new WinGet source. Verifies WinGet is installed properly. ### [Disable-WinGetSetting](Disable-WinGetSetting.md) -{{ Fill in the Description }} +Disables an administrative setting. ### [Enable-WinGetSetting](Enable-WinGetSetting.md) {{ Fill in the Description }} From 497c9dca79884c746c79883f05a91b1b2faac52d Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 15:51:18 -0700 Subject: [PATCH 13/55] fix spelling --- .../Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md index ad1f0d8b40..1827d99a9a 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -19,7 +19,7 @@ Disable-WinGetSetting [-Name] [-ProgressAction ] [ Date: Thu, 25 Jul 2024 16:26:46 -0700 Subject: [PATCH 14/55] Update Disable-WinGetSettings --- .../Disable-WinGetSetting.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md index 1827d99a9a..6c7927c8db 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -19,14 +19,16 @@ Disable-WinGetSetting [-Name] [-ProgressAction ] [ Date: Thu, 25 Jul 2024 17:03:04 -0700 Subject: [PATCH 15/55] Update Export-WinGetPackage --- .../Disable-WinGetSetting.md | 2 +- .../Enable-WinGetSetting.md | 30 ++++++++++--- .../Export-WinGetPackage.md | 45 ++++++++++--------- .../Microsoft.WinGet.Client.md | 4 +- 4 files changed, 51 insertions(+), 30 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md index 6c7927c8db..08302b5092 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -91,4 +91,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-WinGetSettings](Get-WinGetSettings.md) -[Set-WinGetSetting](Set-WinGetSetting.md) \ No newline at end of file +[Set-WinGetSetting](Set-WinGetSetting.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md index 679c0f480f..438ff08a79 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Enable-WinGetSetting ## SYNOPSIS -{{ Fill in the Synopsis }} +Enables an administrative setting. ## SYNTAX @@ -17,21 +17,32 @@ Enable-WinGetSetting [-Name] [-ProgressAction ] [ {{ Add example code here }} +PS C:\> Enable-WinGetSetting -Name LocalManifestFiles ``` -{{ Add example description here }} +Enable the use of local manifest files. ## PARAMETERS ### -Name -{{ Fill Name Description }} +The name of the administrator setting ```yaml Type: System.String @@ -46,7 +57,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -73,3 +87,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Get-WinGetSettings](Get-WinGetSettings.md) + +[Disable-WinGetSetting](Disable-WinGetSetting) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index 16fb7a34db..ef279378d8 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Export-WinGetPackage ## SYNOPSIS -{{ Fill in the Synopsis }} +Downloads a package. ## SYNTAX @@ -30,21 +30,21 @@ Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] ``` ## DESCRIPTION -{{ Fill in the Description }} +Downloads a package installer from the pipeline or from a configured source. The package manifest as well as dependencies and their manifests will be included. The default directory if not specified is the Downloads folder. ## EXAMPLES -### Example 1 +### Example 1: Download Microsoft.PowerShell to the default location ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Export-WinGetPackage -Id Microsoft.PowerShell ``` -{{ Add example description here }} +This example will download the latest available version of the Microsoft.PowerShell installer (for the current system and default scope) and the manifest to a folder (named by concatenating the package identifier with an underscore and the version number) in the Downloads directory. ## PARAMETERS ### -AllowHashMismatch -{{ Fill AllowHashMismatch Description }} +Allow the download even if the SHA256 hash does not match ```yaml Type: System.Management.Automation.SwitchParameter @@ -59,7 +59,7 @@ Accept wildcard characters: False ``` ### -Architecture -{{ Fill Architecture Description }} +Specify the architecture for the installer ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture @@ -75,7 +75,7 @@ Accept wildcard characters: False ``` ### -DownloadDirectory -{{ Fill DownloadDirectory Description }} +Specify the directory for the download ```yaml Type: System.String @@ -90,7 +90,7 @@ Accept wildcard characters: False ``` ### -Id -{{ Fill Id Description }} +Specify the package identifier ```yaml Type: System.String @@ -105,7 +105,7 @@ Accept wildcard characters: False ``` ### -InstallerType -{{ Fill InstallerType Description }} +Specify the installer type ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType @@ -121,7 +121,7 @@ Accept wildcard characters: False ``` ### -Locale -{{ Fill Locale Description }} +Specify the installer locale ```yaml Type: System.String @@ -136,7 +136,7 @@ Accept wildcard characters: False ``` ### -MatchOption -{{ Fill MatchOption Description }} +Specify the match option for a package query ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption @@ -152,7 +152,7 @@ Accept wildcard characters: False ``` ### -Moniker -{{ Fill Moniker Description }} +Specify the moniker ```yaml Type: System.String @@ -167,7 +167,7 @@ Accept wildcard characters: False ``` ### -Name -{{ Fill Name Description }} +Specify the package name ```yaml Type: System.String @@ -182,7 +182,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -197,7 +200,7 @@ Accept wildcard characters: False ``` ### -PSCatalogPackage -{{ Fill PSCatalogPackage Description }} +Specify PSCatalogPackage ```yaml Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage @@ -212,7 +215,7 @@ Accept wildcard characters: False ``` ### -Query -{{ Fill Query Description }} +Search string for package ```yaml Type: System.String[] @@ -227,7 +230,7 @@ Accept wildcard characters: False ``` ### -Scope -{{ Fill Scope Description }} +Specify installer scope ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope @@ -243,7 +246,7 @@ Accept wildcard characters: False ``` ### -SkipDependencies -{{ Fill SkipDependencies Description }} +Specify main package without dependencies ```yaml Type: System.Management.Automation.SwitchParameter @@ -258,7 +261,7 @@ Accept wildcard characters: False ``` ### -Source -{{ Fill Source Description }} +Specify WinGet source ```yaml Type: System.String @@ -273,7 +276,7 @@ Accept wildcard characters: False ``` ### -Version -{{ Fill Version Description }} +Specify package version ```yaml Type: System.String diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index f11f636727..600f22b856 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -21,10 +21,10 @@ Verifies WinGet is installed properly. Disables an administrative setting. ### [Enable-WinGetSetting](Enable-WinGetSetting.md) -{{ Fill in the Description }} +Enables an administrative setting. ### [Export-WinGetPackage](Export-WinGetPackage.md) -{{ Fill in the Description }} +Downloads a package. ### [Find-WinGetPackage](Find-WinGetPackage.md) {{ Fill in the Description }} From 8f8ee78d2d0aefe3ff61eaf0d909c50777d85ef9 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 17:20:40 -0700 Subject: [PATCH 16/55] Update Find-WinGetPackage --- .../Export-WinGetPackage.md | 2 + .../Find-WinGetPackage.md | 54 +++++++++++++------ .../Microsoft.WinGet.Client.md | 2 +- 3 files changed, 42 insertions(+), 16 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index ef279378d8..b897f92877 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -349,3 +349,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Find-WinGetPackage](Find-WinGetPackage.md) \ No newline at end of file diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md index 47a29c1d10..8def0fce61 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Find-WinGetPackage ## SYNOPSIS -{{ Fill in the Synopsis }} +Searches configured sources for packages. ## SYNTAX @@ -19,21 +19,38 @@ Find-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id Find-WinGetPackage PowerShell +``` + +Search for PowerShell. The default behavior spans all configured sources and performs a case insensitive substring match across package identifier, package name, package moniker, and package tags. + +### Example 2: Search for Microsoft.PowerShell by package identifier + ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Find-WinGetPackage -Id Microsoft.PowerShell ``` -{{ Add example description here }} +Search for Microsoft.PowerShell by package identifier. The default behavior spans all configured sources and performs a case insensitive substring match across package identifiers. + +### Example 3: Search for Microsoft.PowerShell by exact package identifier + +```powershell +PS C:\> Find-WinGetPackage -Id Microsoft.PowerShell -MatchOption Equals +``` + +Search for Microsoft.PowerShell by exact package identifier. This search spans all configured sources and performs a case sensitive match across package identifiers. ## PARAMETERS ### -Command -{{ Fill Command Description }} +Specifies command used to run package ```yaml Type: System.String @@ -48,7 +65,7 @@ Accept wildcard characters: False ``` ### -Count -{{ Fill Count Description }} +Specifies maximum number of results to return ```yaml Type: System.UInt32 @@ -63,7 +80,7 @@ Accept wildcard characters: False ``` ### -Id -{{ Fill Id Description }} +Specifies search by package identifier ```yaml Type: System.String @@ -78,7 +95,7 @@ Accept wildcard characters: False ``` ### -MatchOption -{{ Fill MatchOption Description }} +Specifies matching logic for search ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption @@ -94,7 +111,7 @@ Accept wildcard characters: False ``` ### -Moniker -{{ Fill Moniker Description }} +Specifies package moniker ```yaml Type: System.String @@ -109,7 +126,7 @@ Accept wildcard characters: False ``` ### -Name -{{ Fill Name Description }} +Specifies package name ```yaml Type: System.String @@ -124,7 +141,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -139,7 +159,7 @@ Accept wildcard characters: False ``` ### -Query -{{ Fill Query Description }} +Specifies query string to search for ```yaml Type: System.String[] @@ -154,7 +174,7 @@ Accept wildcard characters: False ``` ### -Source -{{ Fill Source Description }} +Specifies WinGet source for search ```yaml Type: System.String @@ -169,7 +189,7 @@ Accept wildcard characters: False ``` ### -Tag -{{ Fill Tag Description }} +Specifies tag to search for ```yaml Type: System.String @@ -203,3 +223,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Export-WinGetPackage](Export-WinGetPackage.md) + +[Install-WinGetPackage](Install-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 index 600f22b856..7c8974fcb2 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -27,7 +27,7 @@ Enables an administrative setting. Downloads a package. ### [Find-WinGetPackage](Find-WinGetPackage.md) -{{ Fill in the Description }} +Searches configured sources for packages. ### [Get-WinGetPackage](Get-WinGetPackage.md) {{ Fill in the Description }} From 6f86f4513e417b9591797df9e78d6348dbd96716 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 25 Jul 2024 17:24:19 -0700 Subject: [PATCH 17/55] Update Find-WinGetPackage --- .../Help/Microsoft.WinGet.Client/Find-WinGetPackage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md index 8def0fce61..07022aa019 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -31,7 +31,7 @@ PS C:\> Find-WinGetPackage PowerShell Search for PowerShell. The default behavior spans all configured sources and performs a case insensitive substring match across package identifier, package name, package moniker, and package tags. -### Example 2: Search for Microsoft.PowerShell by package identifier +### Example 2: Search for Microsoft.PowerShell by id ```powershell PS C:\> Find-WinGetPackage -Id Microsoft.PowerShell @@ -39,7 +39,7 @@ PS C:\> Find-WinGetPackage -Id Microsoft.PowerShell Search for Microsoft.PowerShell by package identifier. The default behavior spans all configured sources and performs a case insensitive substring match across package identifiers. -### Example 3: Search for Microsoft.PowerShell by exact package identifier +### Example 3: Search for Microsoft.PowerShell by exact id ```powershell PS C:\> Find-WinGetPackage -Id Microsoft.PowerShell -MatchOption Equals From 2383aa552c25106f57cc64196324d13d83ab6ab8 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Fri, 26 Jul 2024 10:31:50 -0700 Subject: [PATCH 18/55] Update Get-WinGetPackage --- .../Get-WinGetPackage.md | 40 ++++++++++++------- .../Microsoft.WinGet.Client.md | 2 +- 2 files changed, 26 insertions(+), 16 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md index 4f94874167..ece963a73f 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-WinGetPackage ## SYNOPSIS -{{ Fill in the Synopsis }} +List installed packages. ## SYNTAX @@ -19,21 +19,24 @@ Get-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id **Packages with leading "ARP" or "MSIX" are installed on the device, but not correlated with any configured source. ## EXAMPLES -### Example 1 +### Example 1: Default example + ```powershell -PS C:\> {{ Add example code here }} +Get-WinGetPackage ``` -{{ Add example description here }} +Displays installed packages. ## PARAMETERS ### -Command -{{ Fill Command Description }} +Filter results by their command ```yaml Type: System.String @@ -48,7 +51,7 @@ Accept wildcard characters: False ``` ### -Count -{{ Fill Count Description }} +Limit the number of results ```yaml Type: System.UInt32 @@ -63,7 +66,7 @@ Accept wildcard characters: False ``` ### -Id -{{ Fill Id Description }} +Filter results by their package identifier ```yaml Type: System.String @@ -78,7 +81,7 @@ Accept wildcard characters: False ``` ### -MatchOption -{{ Fill MatchOption Description }} +Specify the matching logic ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption @@ -94,7 +97,7 @@ Accept wildcard characters: False ``` ### -Moniker -{{ Fill Moniker Description }} +Filter results by package moniker ```yaml Type: System.String @@ -109,7 +112,7 @@ Accept wildcard characters: False ``` ### -Name -{{ Fill Name Description }} +Filter results by package name ```yaml Type: System.String @@ -124,7 +127,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -139,7 +145,7 @@ Accept wildcard characters: False ``` ### -Query -{{ Fill Query Description }} +Specifies query string to search for ```yaml Type: System.String[] @@ -154,7 +160,7 @@ Accept wildcard characters: False ``` ### -Source -{{ Fill Source Description }} +Specify the source ```yaml Type: System.String @@ -169,7 +175,7 @@ Accept wildcard characters: False ``` ### -Tag -{{ Fill Tag Description }} +Filter by Tag ```yaml Type: System.String @@ -203,3 +209,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Uninstall-WinGetPackage](Uninstall-WinGetPackage.md) + +[Update-WinGetPackage](Update-WinGetPackage.md) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index 7c8974fcb2..dfb1cd9af9 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -30,7 +30,7 @@ Downloads a package. Searches configured sources for packages. ### [Get-WinGetPackage](Get-WinGetPackage.md) -{{ Fill in the Description }} +List installed packages. ### [Get-WinGetSettings](Get-WinGetSettings.md) {{ Fill in the Description }} From 324430f87c1555b022c2c10e53ceeb3d9c6cb4d8 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Fri, 26 Jul 2024 11:48:56 -0700 Subject: [PATCH 19/55] Update-Get-WinGetSettings --- .../Get-WinGetSettings.md | 19 +++++++++++++------ .../Microsoft.WinGet.Client.md | 2 +- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md index dfd04f8eb2..951cd97b60 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-WinGetSettings ## SYNOPSIS -{{ Fill in the Synopsis }} +Get WinGet settings. ## SYNTAX @@ -17,21 +17,21 @@ Get-WinGetSettings [-AsPlainText] [-ProgressAction ] [ {{ Add example code here }} +PS C:\> Get-WinGetSettings ``` -{{ Add example description here }} +This will display the user settings file location, the administrator settings, and the settings schema URL. ## PARAMETERS ### -AsPlainText -{{ Fill AsPlainText Description }} +Output results as plain text ```yaml Type: System.Management.Automation.SwitchParameter @@ -46,7 +46,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -73,3 +76,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Get-WinGetUserSettings](Get-WinGetUserSettings.md) + +[Set-WinGetUserSettings](Set-WinGetUserSettings.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 index dfb1cd9af9..11f554cc28 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -33,7 +33,7 @@ Searches configured sources for packages. List installed packages. ### [Get-WinGetSettings](Get-WinGetSettings.md) -{{ Fill in the Description }} +Get WinGet settings. ### [Get-WinGetSource](Get-WinGetSource.md) {{ Fill in the Description }} From b6abcfb1691a46e67cc04f56e3e3e9f2b15a1de2 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Fri, 26 Jul 2024 13:59:53 -0700 Subject: [PATCH 20/55] Update Get-WinGetSource --- .../Get-WinGetSource.md | 21 ++++++++++++------- .../Microsoft.WinGet.Client.md | 2 +- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md index 2da3bcf1bc..205714f762 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-WinGetSource ## SYNOPSIS -{{ Fill in the Synopsis }} +List configured WinGet sources. ## SYNTAX @@ -17,21 +17,21 @@ Get-WinGetSource [[-Name] ] [-ProgressAction ] [ {{ Add example code here }} +PS C:\> Get-WinGetSource ``` -{{ Add example description here }} +This will list the configured WinGet sources. The two default sources are "msstore" and "winget". ## PARAMETERS ### -Name -{{ Fill Name Description }} +Filter by WinGet source name ```yaml Type: System.String @@ -46,7 +46,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -74,3 +77,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Add-WinGetSource](Add-WinGetSource.md) + +[Remove-WinGetSource](Remove-WinGetSource.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 index 11f554cc28..eec62e2090 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -36,7 +36,7 @@ List installed packages. Get WinGet settings. ### [Get-WinGetSource](Get-WinGetSource.md) -{{ Fill in the Description }} +List configured WinGet sources. ### [Get-WinGetUserSettings](Get-WinGetUserSettings.md) {{ Fill in the Description }} From a484af6663fb193d90b5fcddd93ab5cd8087f793 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Fri, 26 Jul 2024 15:52:29 -0700 Subject: [PATCH 21/55] Update-GetWinGetUserSettings --- .../Get-WinGetUserSettings.md | 19 +++++++++++++------ .../Microsoft.WinGet.Client.md | 2 +- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md index f316d760c6..3fedb0901c 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-WinGetUserSettings ## SYNOPSIS -{{ Fill in the Synopsis }} +Get user settings for WinGet. ## SYNTAX @@ -17,21 +17,24 @@ Get-WinGetUserSettings [-ProgressAction ] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +Get user settings for WinGet. ## EXAMPLES -### Example 1 +### Example 1: Default ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Get-WinGetUserSettings ``` -{{ Add example description here }} +Get the user settings from the user's settings.json file. ## PARAMETERS ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -59,3 +62,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Get-WinGetSettings](Get-WinGetSettings.md) + +[Set-WinGetUserSettings](Set-WinGetUserSettings.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 index eec62e2090..e066c7fa9e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -39,7 +39,7 @@ Get WinGet settings. List configured WinGet sources. ### [Get-WinGetUserSettings](Get-WinGetUserSettings.md) -{{ Fill in the Description }} +Get user settings for WinGet. ### [Get-WinGetVersion](Get-WinGetVersion.md) {{ Fill in the Description }} From 9199ae31fd7db271e63be7d2326dd6e0d1fa3c16 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Fri, 26 Jul 2024 16:09:24 -0700 Subject: [PATCH 22/55] Update Get-WinGetVersion --- .../Microsoft.WinGet.Client/Get-WinGetVersion.md | 15 +++++++++------ .../Microsoft.WinGet.Client.md | 2 +- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md index 0651e0819f..4931b5ed40 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-WinGetVersion ## SYNOPSIS -{{ Fill in the Synopsis }} +Get the installed version of WinGet. ## SYNTAX @@ -17,21 +17,24 @@ Get-WinGetVersion [-ProgressAction ] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +Get the installed version of WinGet. ## EXAMPLES -### Example 1 +### Example 1: Default example ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Get-WinGetVersion ``` -{{ Add example description here }} +Get the installed version of WinGet. ## PARAMETERS ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index e066c7fa9e..b1660fe871 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -42,7 +42,7 @@ List configured WinGet sources. Get user settings for WinGet. ### [Get-WinGetVersion](Get-WinGetVersion.md) -{{ Fill in the Description }} +Get the installed version of WinGet. ### [Install-WinGetPackage](Install-WinGetPackage.md) {{ Fill in the Description }} From 4c931509871677c56ca46af1efe0571728e3976a Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Fri, 26 Jul 2024 16:36:49 -0700 Subject: [PATCH 23/55] Update Install-WinGetPackage --- .../Install-WinGetPackage.md | 84 +++++++++++++------ .../Microsoft.WinGet.Client.md | 2 +- 2 files changed, 58 insertions(+), 28 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 68619d0ba8..cd6873cbaa 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Install-WinGetPackage ## SYNOPSIS -{{ Fill in the Synopsis }} +Install a WinGet Package. ## SYNTAX @@ -32,21 +32,44 @@ Install-WinGetPackage [-Mode ] [-Override ] [-Cust ``` ## DESCRIPTION -{{ Fill in the Description }} +Install a WinGet package from a configured source. ## EXAMPLES -### Example 1 +### Example 1: Install a package using a query ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Install-WinGetPackage Microsoft.PowerShell ``` -{{ Add example description here }} +This sample installs the Microsoft.PowerShell package. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring the user to pass "-Id". + +### Example 2: Install a package by Id +```powershell +PS C:\> Install-WinGetPackage -Id Microsoft.PowerShell +``` + +This sample installs the Microsoft.PowerShell package by the specifying the package identifier. + +> **If more than one source is configured with the same package identifier, the user must disambiguate** + +### Example 3: Install a package by Name +```powershell +PS C:\> Install-WinGetPackage -Name "PowerToys (Preview)" +``` + +This sample installs the PowerToys package by the specifying the package name. + +### Example 4: Install a specific version of a package +```powershell +PS C:\> Install-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 +``` + +This sample installs the Microsoft.PowerShell package version 7.4.4.0. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. ## PARAMETERS ### -AllowHashMismatch -{{ Fill AllowHashMismatch Description }} +Allow the install to continue even if the SHA256 has does not match. ```yaml Type: System.Management.Automation.SwitchParameter @@ -61,7 +84,7 @@ Accept wildcard characters: False ``` ### -Architecture -{{ Fill Architecture Description }} +Specify the hardware architecture for the installer. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture @@ -77,7 +100,7 @@ Accept wildcard characters: False ``` ### -Custom -{{ Fill Custom Description }} +Arguments to be passed to the installer in addition to those in the manifest. ```yaml Type: System.String @@ -92,7 +115,7 @@ Accept wildcard characters: False ``` ### -Force -{{ Fill Force Description }} +Force the installer to run even when other checks WinGet would perform would prevent this action. ```yaml Type: System.Management.Automation.SwitchParameter @@ -107,7 +130,7 @@ Accept wildcard characters: False ``` ### -Header -{{ Fill Header Description }} +Custom value to be passed via HTTP header to WinGet REST sources. ```yaml Type: System.String @@ -122,7 +145,7 @@ Accept wildcard characters: False ``` ### -Id -{{ Fill Id Description }} +Specifies the package identifier ```yaml Type: System.String @@ -137,7 +160,7 @@ Accept wildcard characters: False ``` ### -InstallerType -{{ Fill InstallerType Description }} +Specifies the installer type ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType @@ -153,7 +176,7 @@ Accept wildcard characters: False ``` ### -Locale -{{ Fill Locale Description }} +Specifies the installer locale ```yaml Type: System.String @@ -168,7 +191,7 @@ Accept wildcard characters: False ``` ### -Location -{{ Fill Location Description }} +Specify the install location. This requires support in the installer. ```yaml Type: System.String @@ -183,7 +206,7 @@ Accept wildcard characters: False ``` ### -Log -{{ Fill Log Description }} +Specify the location for the installer log to be written. ```yaml Type: System.String @@ -198,7 +221,7 @@ Accept wildcard characters: False ``` ### -MatchOption -{{ Fill MatchOption Description }} +Specify the match type. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption @@ -214,7 +237,7 @@ Accept wildcard characters: False ``` ### -Mode -{{ Fill Mode Description }} +Specify the installer output mode. Options are "Default", "Silent", and "Interactive". ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallMode @@ -230,7 +253,7 @@ Accept wildcard characters: False ``` ### -Moniker -{{ Fill Moniker Description }} +Specify the package moniker ```yaml Type: System.String @@ -245,7 +268,7 @@ Accept wildcard characters: False ``` ### -Name -{{ Fill Name Description }} +Specify the package name ```yaml Type: System.String @@ -260,7 +283,7 @@ Accept wildcard characters: False ``` ### -Override -{{ Fill Override Description }} +Specify arguments to pass to the installer. This will override arguments in the manifest. ```yaml Type: System.String @@ -275,7 +298,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -290,7 +316,7 @@ Accept wildcard characters: False ``` ### -PSCatalogPackage -{{ Fill PSCatalogPackage Description }} +WinGet package object ```yaml Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage @@ -305,7 +331,7 @@ Accept wildcard characters: False ``` ### -Query -{{ Fill Query Description }} +Search string. Wildcards are not supported. ```yaml Type: System.String[] @@ -320,7 +346,7 @@ Accept wildcard characters: False ``` ### -Scope -{{ Fill Scope Description }} +Specify installer scope. Valid values are "Any", "User", "System", "UserOrUnknown", "SystemOrUnknown". ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope @@ -336,7 +362,7 @@ Accept wildcard characters: False ``` ### -SkipDependencies -{{ Fill SkipDependencies Description }} +Skip dependency installation. ```yaml Type: System.Management.Automation.SwitchParameter @@ -351,7 +377,7 @@ Accept wildcard characters: False ``` ### -Source -{{ Fill Source Description }} +Specify configured WinGet source. ```yaml Type: System.String @@ -366,7 +392,7 @@ Accept wildcard characters: False ``` ### -Version -{{ Fill Version Description }} +Specify package version. ```yaml Type: System.String @@ -441,3 +467,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Find-WinGetPackage](Find-WinGetPackage.md) + +[Update-WinGetPackage](Update-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 index b1660fe871..a63ec88c55 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -45,7 +45,7 @@ Get user settings for WinGet. Get the installed version of WinGet. ### [Install-WinGetPackage](Install-WinGetPackage.md) -{{ Fill in the Description }} +Install a WinGet Package. ### [Remove-WinGetSource](Remove-WinGetSource.md) {{ Fill in the Description }} From 431f929d7cf4b825286cf2a0fd35a6f5f8463bb5 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Mon, 29 Jul 2024 10:32:27 -0700 Subject: [PATCH 24/55] Updated Remove-WinGetSource --- .../Add-WinGetSource.md | 6 ++++- .../Microsoft.WinGet.Client.md | 2 +- .../Remove-WinGetSource.md | 23 +++++++++++++------ 3 files changed, 22 insertions(+), 9 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index 998fb05f53..308de92038 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Add-WinGetSource ## SYNOPSIS -Add a new source +Add a new source. ## SYNTAX @@ -113,3 +113,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Remove-WinGetSource](Remove-WinGetSource.md) + +[Reset-WinGetSource](Reset-WinGetSource.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 index a63ec88c55..29d9d7f836 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -48,7 +48,7 @@ Get the installed version of WinGet. Install a WinGet Package. ### [Remove-WinGetSource](Remove-WinGetSource.md) -{{ Fill in the Description }} +Remove a configured source. ### [Repair-WinGetPackageManager](Repair-WinGetPackageManager.md) {{ Fill in the Description }} diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md index 540611da1c..75c6040356 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-WinGetSource ## SYNOPSIS -{{ Fill in the Synopsis }} +Remove a configured source. ## SYNTAX @@ -17,21 +17,23 @@ Remove-WinGetSource -Name [-ProgressAction ] [ {{ Add example code here }} +PS C:\> Remove-WinGetSource -Name msstore ``` -{{ Add example description here }} +Removes the "msstore" WinGet source. + +> **Note, you can run Reset-WinGetSource to re-add the default sources back to WinGet.** ## PARAMETERS ### -Name -{{ Fill Name Description }} +The name of the source ```yaml Type: System.String @@ -46,7 +48,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -73,3 +78,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Add-WinGetSource](Add-WinGetSource.md) + +[Reset-WinGetSource](Reset-WinGetSource.md) From 174bd6d36b1296cbde81744653843f7cff27a90b Mon Sep 17 00:00:00 2001 From: ryfu-msft Date: Mon, 29 Jul 2024 10:44:48 -0700 Subject: [PATCH 25/55] repair initial --- .../Microsoft.WinGet.Client.md | 2 +- .../Repair-WinGetPackageManager.md | 17 ++++++++++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index 29d9d7f836..6211e797a5 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -51,7 +51,7 @@ Install a WinGet Package. Remove a configured source. ### [Repair-WinGetPackageManager](Repair-WinGetPackageManager.md) -{{ Fill in the Description }} +Repairs the WinGet client. ### [Reset-WinGetSource](Reset-WinGetSource.md) {{ Fill in the Description }} diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md index 246619551b..422f0b530c 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Repair-WinGetPackageManager ## SYNOPSIS -{{ Fill in the Synopsis }} +Repairs the WinGet client. ## SYNTAX @@ -25,16 +25,23 @@ Repair-WinGetPackageManager [-AllUsers] [-Force] [-Latest] [-IncludePreRelease] ``` ## DESCRIPTION -{{ Fill in the Description }} +Repairs the WinGet client by installing the latest stable version of the client. #TODO ## EXAMPLES -### Example 1 +### Example 1: Repair the WinGet client. ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Repair-WinGetPackageManager ``` -{{ Add example description here }} +Ensures the current installed version of WinGet is functional. + +### Example 2: Force install the latest version. +```powershell +PS C:\> Repair-WinGetPackageManager -Latest -Force +``` + +Install the latest version of WinGet and ensure it functions. ## PARAMETERS From 46f1f9184d728244cc00f39b40117e2c86e2a584 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Mon, 29 Jul 2024 11:04:50 -0700 Subject: [PATCH 26/55] Update Update-WinGetPackage --- .../Microsoft.WinGet.Client.md | 2 +- .../Update-WinGetPackage.md | 65 +++++++++++-------- 2 files changed, 38 insertions(+), 29 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index 6211e797a5..c7812c0a0b 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -66,5 +66,5 @@ Repairs the WinGet client. {{ Fill in the Description }} ### [Update-WinGetPackage](Update-WinGetPackage.md) -{{ Fill in the Description }} +Update a WinGet package. diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md index cc066fb3d2..977e691779 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-WinGetPackage ## SYNOPSIS -{{ Fill in the Synopsis }} +Update a WinGet package. ## SYNTAX @@ -32,21 +32,21 @@ Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ``` ## DESCRIPTION -{{ Fill in the Description }} +Update a WinGet package. ## EXAMPLES -### Example 1 +### Example 1: Update by WinGet identifier. ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Update-WinGetPackage -Id Microsoft.PowerShell ``` -{{ Add example description here }} +Update the Microsoft.PowerShell package by Id. ## PARAMETERS ### -AllowHashMismatch -{{ Fill AllowHashMismatch Description }} +Update the package even if the installer download SHA256 doesn't match the manifest. ```yaml Type: System.Management.Automation.SwitchParameter @@ -61,7 +61,7 @@ Accept wildcard characters: False ``` ### -Architecture -{{ Fill Architecture Description }} +Specify the installer architecture. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture @@ -77,7 +77,7 @@ Accept wildcard characters: False ``` ### -Custom -{{ Fill Custom Description }} +Add additional arguments to the installer command. ```yaml Type: System.String @@ -92,7 +92,7 @@ Accept wildcard characters: False ``` ### -Force -{{ Fill Force Description }} +Force the update to run the installer. ```yaml Type: System.Management.Automation.SwitchParameter @@ -107,7 +107,7 @@ Accept wildcard characters: False ``` ### -Header -{{ Fill Header Description }} +Specify a custom value in the HTTP header to the REST source. ```yaml Type: System.String @@ -122,7 +122,7 @@ Accept wildcard characters: False ``` ### -Id -{{ Fill Id Description }} +Specify the package identifier. ```yaml Type: System.String @@ -137,7 +137,7 @@ Accept wildcard characters: False ``` ### -IncludeUnknown -{{ Fill IncludeUnknown Description }} +Attempt to upgrade the package when the installed version is not specified in the registry. ```yaml Type: System.Management.Automation.SwitchParameter @@ -152,7 +152,7 @@ Accept wildcard characters: False ``` ### -InstallerType -{{ Fill InstallerType Description }} +Specify the installer type to use. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType @@ -168,7 +168,7 @@ Accept wildcard characters: False ``` ### -Locale -{{ Fill Locale Description }} +Specify the installer locale. ```yaml Type: System.String @@ -183,7 +183,9 @@ Accept wildcard characters: False ``` ### -Location -{{ Fill Location Description }} +Specify the location to install the package. + +> **Note: Not all installers support this property.** ```yaml Type: System.String @@ -198,7 +200,9 @@ Accept wildcard characters: False ``` ### -Log -{{ Fill Log Description }} +Specify the location for the installer log. + +> **Note: Not all installers support this property.** ```yaml Type: System.String @@ -213,7 +217,7 @@ Accept wildcard characters: False ``` ### -MatchOption -{{ Fill MatchOption Description }} +Specify the match type to use. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption @@ -229,7 +233,7 @@ Accept wildcard characters: False ``` ### -Mode -{{ Fill Mode Description }} +Specify the installer output mode. Options are "Default", "Silent", and "Interactive". ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallMode @@ -245,7 +249,7 @@ Accept wildcard characters: False ``` ### -Moniker -{{ Fill Moniker Description }} +Specify the moniker. ```yaml Type: System.String @@ -260,7 +264,7 @@ Accept wildcard characters: False ``` ### -Name -{{ Fill Name Description }} +Specify the name. ```yaml Type: System.String @@ -275,7 +279,7 @@ Accept wildcard characters: False ``` ### -Override -{{ Fill Override Description }} +Override the switches to pass to the installer. ```yaml Type: System.String @@ -290,7 +294,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -305,7 +312,7 @@ Accept wildcard characters: False ``` ### -PSCatalogPackage -{{ Fill PSCatalogPackage Description }} +WinGet package object ```yaml Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage @@ -320,7 +327,7 @@ Accept wildcard characters: False ``` ### -Query -{{ Fill Query Description }} +Search string. Wildcards are not supported. ```yaml Type: System.String[] @@ -335,7 +342,7 @@ Accept wildcard characters: False ``` ### -Scope -{{ Fill Scope Description }} +Specify installer scope. Valid values are "Any", "User", "System", "UserOrUnknown", "SystemOrUnknown". ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope @@ -351,7 +358,7 @@ Accept wildcard characters: False ``` ### -SkipDependencies -{{ Fill SkipDependencies Description }} +Skip dependency installation. ```yaml Type: System.Management.Automation.SwitchParameter @@ -366,7 +373,7 @@ Accept wildcard characters: False ``` ### -Source -{{ Fill Source Description }} +Specify configured WinGet source. ```yaml Type: System.String @@ -381,7 +388,7 @@ Accept wildcard characters: False ``` ### -Version -{{ Fill Version Description }} +Specify package version. ```yaml Type: System.String @@ -456,3 +463,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Get-WinGetPackage](Get-WinGetPackage.md) From cd7ee9625f485f123faf9be5aff9d7a60aaf78b5 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Mon, 29 Jul 2024 11:18:05 -0700 Subject: [PATCH 27/55] Update Uninstall-WinGetPackage --- .../Microsoft.WinGet.Client.md | 2 +- .../Uninstall-WinGetPackage.md | 43 +++++++++++-------- 2 files changed, 27 insertions(+), 18 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index c7812c0a0b..ce26014427 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -63,7 +63,7 @@ Repairs the WinGet client. {{ Fill in the Description }} ### [Uninstall-WinGetPackage](Uninstall-WinGetPackage.md) -{{ Fill in the Description }} +Uninstall a WinGet Package. ### [Update-WinGetPackage](Update-WinGetPackage.md) Update a WinGet package. diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md index a79dc6db0f..079ff3350b 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Uninstall-WinGetPackage ## SYNOPSIS -{{ Fill in the Synopsis }} +Uninstall a WinGet Package. ## SYNTAX @@ -28,21 +28,21 @@ Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ``` ## DESCRIPTION -{{ Fill in the Description }} +Uninstall a WinGet Package. ## EXAMPLES -### Example 1 +### Example 1: Uninstall a package by Id ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Uninstall-WinGetPackage -Id Microsoft.PowerToys ``` -{{ Add example description here }} +Uninstall Microsoft.PowerToys by package identifier. ## PARAMETERS ### -Force -{{ Fill Force Description }} +Force the uninstall to run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -57,7 +57,7 @@ Accept wildcard characters: False ``` ### -Id -{{ Fill Id Description }} +Specify package identifier ```yaml Type: System.String @@ -72,7 +72,9 @@ Accept wildcard characters: False ``` ### -Log -{{ Fill Log Description }} +Specify log location for uninstall. + +> **Note: Not all uninstallers support this option.** ```yaml Type: System.String @@ -87,7 +89,7 @@ Accept wildcard characters: False ``` ### -MatchOption -{{ Fill MatchOption Description }} +Specify the match type to use. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption @@ -103,7 +105,9 @@ Accept wildcard characters: False ``` ### -Mode -{{ Fill Mode Description }} +Specify the installer output mode. Options are "Default", "Silent", and "Interactive". + +> **Note: Not all uninstallers support all modes.** ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageUninstallMode @@ -119,7 +123,7 @@ Accept wildcard characters: False ``` ### -Moniker -{{ Fill Moniker Description }} +Specify the moniker. ```yaml Type: System.String @@ -134,7 +138,7 @@ Accept wildcard characters: False ``` ### -Name -{{ Fill Name Description }} +Specify the name. ```yaml Type: System.String @@ -149,7 +153,10 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} + +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -164,7 +171,7 @@ Accept wildcard characters: False ``` ### -PSCatalogPackage -{{ Fill PSCatalogPackage Description }} +WinGet package object ```yaml Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage @@ -179,7 +186,7 @@ Accept wildcard characters: False ``` ### -Query -{{ Fill Query Description }} +Search string. Wildcards are not supported. ```yaml Type: System.String[] @@ -194,7 +201,7 @@ Accept wildcard characters: False ``` ### -Source -{{ Fill Source Description }} +Specify configured WinGet source. ```yaml Type: System.String @@ -209,7 +216,7 @@ Accept wildcard characters: False ``` ### -Version -{{ Fill Version Description }} +Specify the version. ```yaml Type: System.String @@ -278,3 +285,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Get-WinGetPackage](Get-WinGetPackage.md) From 9bc2f088afee6823f13a117d95aa8b1083e54c34 Mon Sep 17 00:00:00 2001 From: ryfu-msft Date: Tue, 30 Jul 2024 15:55:39 -0700 Subject: [PATCH 28/55] finish the rest of the cmdlets --- .../Get-WinGetSettings.md | 2 +- .../Install-WinGetPackage.md | 14 +-- .../Microsoft.WinGet.Client.md | 11 ++- .../Remove-WinGetSource.md | 3 +- .../Repair-WinGetPackageManager.md | 18 ++-- .../Reset-WinGetSource.md | 20 +++-- .../Set-WinGetUserSettings.md | 28 ++++-- .../Test-WinGetUserSettings.md | 31 +++++-- .../Uninstall-WinGetPackage.md | 65 ++++++++++---- .../Update-WinGetPackage.md | 89 +++++++++++++------ 10 files changed, 189 insertions(+), 92 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md index 951cd97b60..13d0b1bf08 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -17,7 +17,7 @@ Get-WinGetSettings [-AsPlainText] [-ProgressAction ] [ Repair-WinGetPackageManager -Latest -Force ``` -Install the latest version of WinGet and ensure it functions. +Installs the latest version of WinGet and ensures it functions properly. ## PARAMETERS ### -AllUsers -{{ Fill AllUsers Description }} +Indicates that this cmdlet repairs the WinGet client for all user accounts on the computer. To use this parameter, you must run the command with administrator permissions. ```yaml Type: System.Management.Automation.SwitchParameter @@ -61,7 +61,7 @@ Accept wildcard characters: False ``` ### -Force -{{ Fill Force Description }} +Force the repair even when other checks WinGet would perform would prevent this action. ```yaml Type: System.Management.Automation.SwitchParameter @@ -76,7 +76,7 @@ Accept wildcard characters: False ``` ### -IncludePreRelease -{{ Fill IncludePreRelease Description }} +Includes prerelease versions of the WinGet client. ```yaml Type: System.Management.Automation.SwitchParameter @@ -91,7 +91,7 @@ Accept wildcard characters: False ``` ### -Latest -{{ Fill Latest Description }} +Installs the latest available version of the WinGet client. ```yaml Type: System.Management.Automation.SwitchParameter @@ -106,7 +106,9 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -121,7 +123,7 @@ Accept wildcard characters: False ``` ### -Version -{{ Fill Version Description }} +Specify the WinGet client version. ```yaml Type: System.String diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md index d52a4c9724..71b1ed130d 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Reset-WinGetSource ## SYNOPSIS -{{ Fill in the Synopsis }} +Reset default WinGet sources. ## SYNTAX @@ -17,21 +17,21 @@ Reset-WinGetSource -Name [-ProgressAction ] [ {{ Add example code here }} +PS C:\> Reset-WinGetSource -Name msstore ``` -{{ Add example description here }} +This example resets the configured source named 'msstore' by removing it. ## PARAMETERS ### -Name -{{ Fill Name Description }} +The name of the source. ```yaml Type: System.String @@ -46,7 +46,9 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -73,3 +75,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Add-WinGetSource](Add-WinGetSource.md) + +[Remove-WinGetSource](Remove-WinGetSource.md) \ No newline at end of file diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md index 9ee7e32d0d..f2fbe3d233 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Set-WinGetUserSettings ## SYNOPSIS -{{ Fill in the Synopsis }} +Set WinGet settings. ## SYNTAX @@ -18,21 +18,27 @@ Set-WinGetUserSettings -UserSettings [-Merge] [-ProgressAction {{ Add example code here }} +PS C:\> Set-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } ``` +Sets the theme of the progress bar to rainbow. -{{ Add example description here }} +### Example 2: Merge install behavior settings. +```powershell +PS C:\> Set-WinGetUserSettings -UserSettings @{ installBehavior= @{ preferences= @{ scope = "user"}} } -Merge +``` + +Appends the user scope preference setting to the existing WinGet settings configuration. ## PARAMETERS ### -Merge -{{ Fill Merge Description }} +Appends the provided UserSettings input to the existing settings configuration. ```yaml Type: System.Management.Automation.SwitchParameter @@ -47,7 +53,9 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -62,7 +70,7 @@ Accept wildcard characters: False ``` ### -UserSettings -{{ Fill UserSettings Description }} +A hashtable containing the key value pairs representing the WinGet settings. ```yaml Type: System.Collections.Hashtable @@ -92,3 +100,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Get-WinGetUserSettings](Get-WinGetUserSettings.md) + +[Test-WinGetUserSettings](Test-WinGetUserSettings.md) \ No newline at end of file diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md index ea44982e34..baf7b167aa 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Test-WinGetUserSettings ## SYNOPSIS -{{ Fill in the Synopsis }} +Test the WinGet settings. ## SYNTAX @@ -18,21 +18,28 @@ Test-WinGetUserSettings -UserSettings [-IgnoreNotSet] [-ProgressActi ``` ## DESCRIPTION -{{ Fill in the Description }} +Tests whether the provided UserSettings matches the current WinGet settings configuration. ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### Example 1: Test for exact match. +```powershell +PS C:\> Test-WinGetUserSettings -UserSettings @{ installBehavior= @{ preferences= @{ scope = "user"}} } ``` -{{ Add example description here }} +Tests if the provided input matches the current WinGet settings configuration. This command will return False if it is not an exact match.. + +### Example 2: Test only progress bar setting. +```powershell +PS C:\> Test-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } -Merge +``` + +Tests if the progress bar theme is set to rainbow. Including the -Merge argument does not include other WinGet settings in the comparison. ## PARAMETERS ### -IgnoreNotSet -{{ Fill IgnoreNotSet Description }} +Ignore settings that are not specified in the input. ```yaml Type: System.Management.Automation.SwitchParameter @@ -47,7 +54,9 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -62,7 +71,7 @@ Accept wildcard characters: False ``` ### -UserSettings -{{ Fill UserSettings Description }} +A hashtable containing the key value pairs representing the WinGet settings. ```yaml Type: System.Collections.Hashtable @@ -92,3 +101,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Get-WinGetUserSettings](Get-WinGetUserSettings.md) + +[Set-WinGetUserSettings](Set-WinGetUserSettings.md) \ No newline at end of file diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md index a79dc6db0f..352675f899 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Uninstall-WinGetPackage ## SYNOPSIS -{{ Fill in the Synopsis }} +Uninstall a WinGet Package. ## SYNTAX @@ -28,21 +28,44 @@ Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ``` ## DESCRIPTION -{{ Fill in the Description }} +Uninstalls the selected package found by searching the installed packages list. ## EXAMPLES -### Example 1 +### Example 1: Uninstall a package using a query ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Uninstall-WinGetPackage Microsoft.PowerShell ``` -{{ Add example description here }} +This sample uninstalls the Microsoft.PowerShell package. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring the user to pass "-Id". + +### Example 2: Uninstall a package by Id +```powershell +PS C:\> Uninstall-WinGetPackage -Id Microsoft.PowerShell +``` + +This sample uninstalls the Microsoft.PowerShell package by the specifying the package identifier. + +> **If more than one source is configured with the same package identifier, the user must disambiguate** + +### Example 3: Uninstall a package by Name +```powershell +PS C:\> 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 +PS C:\> Uninstall-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 +``` + +This sample uninstalls the Microsoft.PowerShell package version 7.4.4.0. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. ## PARAMETERS ### -Force -{{ Fill Force Description }} +Force the uninstall even when other checks WinGet would perform would prevent this action. ```yaml Type: System.Management.Automation.SwitchParameter @@ -57,7 +80,7 @@ Accept wildcard characters: False ``` ### -Id -{{ Fill Id Description }} +Specifies the package identifier. ```yaml Type: System.String @@ -72,7 +95,7 @@ Accept wildcard characters: False ``` ### -Log -{{ Fill Log Description }} +Specify the location for the installer log to be written. ```yaml Type: System.String @@ -87,7 +110,7 @@ Accept wildcard characters: False ``` ### -MatchOption -{{ Fill MatchOption Description }} +Specify the match type. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption @@ -103,7 +126,7 @@ Accept wildcard characters: False ``` ### -Mode -{{ Fill Mode Description }} +Specify the installer output mode. Options are "Default", "Silent", and "Interactive". ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageUninstallMode @@ -119,7 +142,7 @@ Accept wildcard characters: False ``` ### -Moniker -{{ Fill Moniker Description }} +Specify the package moniker ```yaml Type: System.String @@ -134,7 +157,7 @@ Accept wildcard characters: False ``` ### -Name -{{ Fill Name Description }} +Specify the package name. ```yaml Type: System.String @@ -149,7 +172,9 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -164,7 +189,7 @@ Accept wildcard characters: False ``` ### -PSCatalogPackage -{{ Fill PSCatalogPackage Description }} +WinGet package object. ```yaml Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage @@ -179,7 +204,7 @@ Accept wildcard characters: False ``` ### -Query -{{ Fill Query Description }} +Search string. Wildcards are not supported. ```yaml Type: System.String[] @@ -194,7 +219,7 @@ Accept wildcard characters: False ``` ### -Source -{{ Fill Source Description }} +Specify configured WinGet source. ```yaml Type: System.String @@ -209,7 +234,7 @@ Accept wildcard characters: False ``` ### -Version -{{ Fill Version Description }} +Specify package version. ```yaml Type: System.String @@ -278,3 +303,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Find-WinGetPackage](Find-WinGetPackage.md) + +[Update-WinGetPackage](Update-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 index cc066fb3d2..33c1dec71d 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-WinGetPackage ## SYNOPSIS -{{ Fill in the Synopsis }} +Update a WinGet Package. ## SYNTAX @@ -32,21 +32,44 @@ Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ``` ## DESCRIPTION -{{ Fill in the Description }} +Updates the selected package found by searching the installed packages list. ## EXAMPLES -### Example 1 +### Example 1: Update a package using a query ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Update-WinGetPackage Microsoft.PowerShell ``` -{{ Add example description here }} +This sample updates the Microsoft.PowerShell package. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring the user to pass "-Id". + +### Example 2: Update a package by Id +```powershell +PS C:\> Update-WinGetPackage -Id Microsoft.PowerShell +``` + +This sample updates the Microsoft.PowerShell package by the specifying the package identifier. + +> **If more than one source is configured with the same package identifier, the user must disambiguate** + +### Example 3: Update a package by Name +```powershell +PS C:\> 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 +PS C:\> Update-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 +``` + +This sample updates the Microsoft.PowerShell package to version 7.4.4.0. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. ## PARAMETERS ### -AllowHashMismatch -{{ Fill AllowHashMismatch Description }} +Allow the install to continue even if the SHA256 has does not match. ```yaml Type: System.Management.Automation.SwitchParameter @@ -61,7 +84,7 @@ Accept wildcard characters: False ``` ### -Architecture -{{ Fill Architecture Description }} +Specify the hardware architecture for the installer. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture @@ -77,7 +100,7 @@ Accept wildcard characters: False ``` ### -Custom -{{ Fill Custom Description }} +Arguments to be passed to the installer in addition to those in the manifest. ```yaml Type: System.String @@ -92,7 +115,7 @@ Accept wildcard characters: False ``` ### -Force -{{ Fill Force Description }} +Force the installer to run even when other checks WinGet would perform would prevent this action. ```yaml Type: System.Management.Automation.SwitchParameter @@ -107,7 +130,7 @@ Accept wildcard characters: False ``` ### -Header -{{ Fill Header Description }} +Custom value to be passed via HTTP header to WinGet REST sources. ```yaml Type: System.String @@ -122,7 +145,7 @@ Accept wildcard characters: False ``` ### -Id -{{ Fill Id Description }} +Specifies the package identifier. ```yaml Type: System.String @@ -137,7 +160,7 @@ Accept wildcard characters: False ``` ### -IncludeUnknown -{{ Fill IncludeUnknown Description }} +Upgrade packages even if their current version cannot be determined. ```yaml Type: System.Management.Automation.SwitchParameter @@ -152,7 +175,7 @@ Accept wildcard characters: False ``` ### -InstallerType -{{ Fill InstallerType Description }} +Specifies the installer type. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType @@ -168,7 +191,7 @@ Accept wildcard characters: False ``` ### -Locale -{{ Fill Locale Description }} +Specifies the installer locale. ```yaml Type: System.String @@ -183,7 +206,7 @@ Accept wildcard characters: False ``` ### -Location -{{ Fill Location Description }} +Specify the install location. This requires support in the installer. ```yaml Type: System.String @@ -198,7 +221,7 @@ Accept wildcard characters: False ``` ### -Log -{{ Fill Log Description }} +Specify the location for the installer log to be written. ```yaml Type: System.String @@ -213,7 +236,7 @@ Accept wildcard characters: False ``` ### -MatchOption -{{ Fill MatchOption Description }} +Specify the match type. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption @@ -229,7 +252,7 @@ Accept wildcard characters: False ``` ### -Mode -{{ Fill Mode Description }} +Specify the installer output mode. Options are "Default", "Silent", and "Interactive". ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallMode @@ -245,7 +268,7 @@ Accept wildcard characters: False ``` ### -Moniker -{{ Fill Moniker Description }} +Specify the package moniker. ```yaml Type: System.String @@ -260,7 +283,7 @@ Accept wildcard characters: False ``` ### -Name -{{ Fill Name Description }} +Specify the package name. ```yaml Type: System.String @@ -275,7 +298,7 @@ Accept wildcard characters: False ``` ### -Override -{{ Fill Override Description }} +Specify arguments to pass to the installer. This will override arguments in the manifest. ```yaml Type: System.String @@ -290,7 +313,9 @@ Accept wildcard characters: False ``` ### -ProgressAction -{{ Fill ProgressAction Description }} +Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. + +This parameter was added in PowerShell 7.4. ```yaml Type: System.Management.Automation.ActionPreference @@ -305,7 +330,7 @@ Accept wildcard characters: False ``` ### -PSCatalogPackage -{{ Fill PSCatalogPackage Description }} +WinGet package object. ```yaml Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage @@ -320,7 +345,7 @@ Accept wildcard characters: False ``` ### -Query -{{ Fill Query Description }} +Search string. Wildcards are not supported. ```yaml Type: System.String[] @@ -335,7 +360,7 @@ Accept wildcard characters: False ``` ### -Scope -{{ Fill Scope Description }} +Specify installer scope. Valid values are "Any", "User", "System", "UserOrUnknown", "SystemOrUnknown". ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope @@ -351,7 +376,7 @@ Accept wildcard characters: False ``` ### -SkipDependencies -{{ Fill SkipDependencies Description }} +Skip dependency installation. ```yaml Type: System.Management.Automation.SwitchParameter @@ -366,7 +391,7 @@ Accept wildcard characters: False ``` ### -Source -{{ Fill Source Description }} +Specify configured WinGet source. ```yaml Type: System.String @@ -381,7 +406,7 @@ Accept wildcard characters: False ``` ### -Version -{{ Fill Version Description }} +Specify package version. ```yaml Type: System.String @@ -456,3 +481,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Find-WinGetPackage](Find-WinGetPackage.md) + +[Update-WinGetPackage](Update-WinGetPackage.md) + +[Install-WinGetPackage](Install-WinGetPackage.md) + +[Uninstall-WinGetPackage](Uninstall-WinGetPackage.md) \ No newline at end of file From e6cd16f3d61577310e199fead66fdccb322a9ff8 Mon Sep 17 00:00:00 2001 From: ryfu-msft Date: Tue, 30 Jul 2024 16:02:17 -0700 Subject: [PATCH 29/55] resolve and push changes --- .../Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md index 8e696dbd5c..b292ba0df6 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -309,3 +309,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-WinGetPackage](Get-WinGetPackage.md) + +[Install-WinGetPackage](Install-WinGetPackage.md) From d48abfa9800365458d4ec3df61e0273364bd17ba Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Tue, 30 Jul 2024 16:14:54 -0700 Subject: [PATCH 30/55] Update Test-WinGetUserSettings --- .../Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md index baf7b167aa..47ef55dcce 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md @@ -31,10 +31,10 @@ Tests if the provided input matches the current WinGet settings configuration. T ### Example 2: Test only progress bar setting. ```powershell -PS C:\> Test-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } -Merge +PS C:\> Test-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } -IgnoreNotSet ``` -Tests if the progress bar theme is set to rainbow. Including the -Merge argument does not include other WinGet settings in the comparison. +Tests if the progress bar theme is set to rainbow. Including the -IgnoreNotSet argument does not include other WinGet settings in the comparison. ## PARAMETERS From a922bd1de205e7e46b14f9087cfaebe4b5b6ff72 Mon Sep 17 00:00:00 2001 From: Muhammad Danish <88161975+mdanish-kh@users.noreply.github.com> Date: Wed, 31 Jul 2024 23:31:58 +0500 Subject: [PATCH 31/55] Remove ProgressAction from syntax and descriptions --- .../Add-WinGetSource.md | 25 ++-------------- .../Assert-WinGetPackageManager.md | 25 ++-------------- .../Disable-WinGetSetting.md | 22 ++------------ .../Enable-WinGetSetting.md | 22 ++------------ .../Export-WinGetPackage.md | 28 ++++------------- .../Find-WinGetPackage.md | 22 ++------------ .../Get-WinGetPackage.md | 22 ++------------ .../Get-WinGetSettings.md | 22 ++------------ .../Get-WinGetSource.md | 22 ++------------ .../Get-WinGetUserSettings.md | 22 ++------------ .../Get-WinGetVersion.md | 22 ++------------ .../Install-WinGetPackage.md | 28 ++++------------- .../Remove-WinGetSource.md | 21 ++----------- .../Repair-WinGetPackageManager.md | 24 ++------------- .../Reset-WinGetSource.md | 23 ++------------ .../Set-WinGetUserSettings.md | 24 ++------------- .../Test-WinGetUserSettings.md | 30 ++++--------------- .../Uninstall-WinGetPackage.md | 28 ++++------------- .../Update-WinGetPackage.md | 27 ++++------------- 19 files changed, 59 insertions(+), 400 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index 308de92038..10f5483f19 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -13,8 +13,7 @@ Add a new source. ## SYNTAX ``` -Add-WinGetSource -Name -Argument [-Type ] [-ProgressAction ] - [] +Add-WinGetSource -Name -Argument [-Type ] [] ``` ## DESCRIPTION @@ -28,7 +27,7 @@ Add a new WinGet source. PS C:\> Add-WinGetSource -Name mysource -Argument https://contoso.com/ -Type Microsoft.Rest ``` -This example adds a new REST based source to WinGet named "mysource" with the root URL https://contoso.com/. +This example adds a new REST based source to WinGet named "mysource" with the root URL https://contoso.com/. > **This example is illustrative and will not succeed because WinGet will not add a source that does not properly respond to the WinGet REST API** @@ -67,24 +66,6 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Type Type of the source. Most sources will be "Microsoft.Rest". The WinGet community repository is "Microsoft.PreIndexed.Package". @@ -101,7 +82,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md index 67b178d9c3..93509bdea5 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md @@ -14,13 +14,12 @@ Verifies WinGet is installed properly. ### IntegrityVersionSet (Default) ``` -Assert-WinGetPackageManager [-Version ] [-ProgressAction ] [] +Assert-WinGetPackageManager [-Version ] [] ``` ### IntegrityLatestSet ``` -Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [-ProgressAction ] - [] +Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [] ``` ## DESCRIPTION @@ -94,24 +93,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Version Verifies a specific version of WinGet is installed. @@ -128,7 +109,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md index 08302b5092..ecdc164353 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -13,7 +13,7 @@ Disables an administrative setting. ## SYNTAX ``` -Disable-WinGetSetting [-Name] [-ProgressAction ] [] +Disable-WinGetSetting [-Name] [] ``` ## DESCRIPTION @@ -57,26 +57,8 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md index 438ff08a79..f0cb9047a7 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md @@ -13,7 +13,7 @@ Enables an administrative setting. ## SYNTAX ``` -Enable-WinGetSetting [-Name] [-ProgressAction ] [] +Enable-WinGetSetting [-Name] [] ``` ## DESCRIPTION @@ -56,26 +56,8 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index b897f92877..936fd05560 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -18,7 +18,7 @@ Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] [-Scope ] [-SkipDependencies] [-Version ] [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] + [-WhatIf] [-Confirm] [] ``` ### GivenSet @@ -26,7 +26,7 @@ Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] [-Scope ] [-SkipDependencies] [[-PSCatalogPackage] ] - [-Version ] [-ProgressAction ] [-WhatIf] [-Confirm] [] + [-Version ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,7 +36,7 @@ Downloads a package installer from the pipeline or from a configured source. The ### Example 1: Download Microsoft.PowerShell to the default location ```powershell -PS C:\> Export-WinGetPackage -Id Microsoft.PowerShell +PS C:\> Export-WinGetPackage -Id Microsoft.PowerShell ``` This example will download the latest available version of the Microsoft.PowerShell installer (for the current system and default scope) and the manifest to a folder (named by concatenating the package identifier with an underscore and the version number) in the Downloads directory. @@ -181,24 +181,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -PSCatalogPackage Specify PSCatalogPackage @@ -322,7 +304,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -350,4 +332,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Find-WinGetPackage](Find-WinGetPackage.md) \ No newline at end of file +[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 index 07022aa019..2eb5dad68f 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -15,7 +15,7 @@ Searches configured sources for packages. ``` Find-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] - [-ProgressAction ] [] + [] ``` ## DESCRIPTION @@ -140,24 +140,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Query Specifies query string to search for @@ -204,7 +186,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md index ece963a73f..896dbc81f6 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md @@ -15,7 +15,7 @@ List installed packages. ``` Get-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] - [-ProgressAction ] [] + [] ``` ## DESCRIPTION @@ -126,24 +126,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Query Specifies query string to search for @@ -190,7 +172,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md index 13d0b1bf08..6c94b6c1d8 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -13,7 +13,7 @@ Get WinGet settings. ## SYNTAX ``` -Get-WinGetSettings [-AsPlainText] [-ProgressAction ] [] +Get-WinGetSettings [-AsPlainText] [] ``` ## DESCRIPTION @@ -45,26 +45,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md index 205714f762..8b9ed88161 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md @@ -13,7 +13,7 @@ List configured WinGet sources. ## SYNTAX ``` -Get-WinGetSource [[-Name] ] [-ProgressAction ] [] +Get-WinGetSource [[-Name] ] [] ``` ## DESCRIPTION @@ -45,26 +45,8 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md index 3fedb0901c..1f5be9f951 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md @@ -13,7 +13,7 @@ Get user settings for WinGet. ## SYNTAX ``` -Get-WinGetUserSettings [-ProgressAction ] [] +Get-WinGetUserSettings [] ``` ## DESCRIPTION @@ -30,26 +30,8 @@ Get the user settings from the user's settings.json file. ## PARAMETERS -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md index 4931b5ed40..ee01a94def 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md @@ -13,7 +13,7 @@ Get the installed version of WinGet. ## SYNTAX ``` -Get-WinGetVersion [-ProgressAction ] [] +Get-WinGetVersion [] ``` ## DESCRIPTION @@ -30,26 +30,8 @@ Get the installed version of WinGet. ## PARAMETERS -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 81defc8b8f..4d55721f34 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -19,7 +19,7 @@ Install-WinGetPackage [-Mode ] [-Override ] [-Cust [-Architecture ] [-InstallerType ] [-Locale ] [-Scope ] [-SkipDependencies] [-Version ] [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] + [-WhatIf] [-Confirm] [] ``` ### GivenSet @@ -28,7 +28,7 @@ Install-WinGetPackage [-Mode ] [-Override ] [-Cust [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] [-Scope ] [-SkipDependencies] [[-PSCatalogPackage] ] - [-Version ] [-ProgressAction ] [-WhatIf] [-Confirm] [] + [-Version ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -48,7 +48,7 @@ This sample installs the Microsoft.PowerShell package. No specific property to i PS C:\> Install-WinGetPackage -Id Microsoft.PowerShell ``` -This sample installs the Microsoft.PowerShell package by the specifying the package identifier. +This sample installs the Microsoft.PowerShell package by the specifying the package identifier. > **If more than one source is configured with the same package identifier, the user must disambiguate** @@ -57,7 +57,7 @@ This sample installs the Microsoft.PowerShell package by the specifying the pack PS C:\> Install-WinGetPackage -Name "PowerToys (Preview)" ``` -This sample installs the PowerToys package by the specifying the package name. +This sample installs the PowerToys package by the specifying the package name. ### Example 4: Install a specific version of a package ```powershell @@ -297,24 +297,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction - -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -PSCatalogPackage WinGet package object. @@ -438,7 +420,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md index 69639e7c4f..e49aec4a7b 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md @@ -13,7 +13,7 @@ Remove a configured source. ## SYNTAX ``` -Remove-WinGetSource -Name [-ProgressAction ] [] +Remove-WinGetSource -Name [] ``` ## DESCRIPTION @@ -47,25 +47,8 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -ProgressAction -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md index c2526f4e62..4f4597a982 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md @@ -14,14 +14,13 @@ Repairs the WinGet client. ### IntegrityVersionSet (Default) ``` -Repair-WinGetPackageManager [-AllUsers] [-Force] [-Version ] [-ProgressAction ] - [] +Repair-WinGetPackageManager [-AllUsers] [-Force] [-Version ] [] ``` ### IntegrityLatestSet ``` Repair-WinGetPackageManager [-AllUsers] [-Force] [-Latest] [-IncludePreRelease] - [-ProgressAction ] [] + [] ``` ## DESCRIPTION @@ -105,23 +104,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Version Specify the WinGet client version. @@ -138,7 +120,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md index 71b1ed130d..12e2bca850 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md @@ -13,7 +13,7 @@ Reset default WinGet sources. ## SYNTAX ``` -Reset-WinGetSource -Name [-ProgressAction ] [] +Reset-WinGetSource -Name [] ``` ## DESCRIPTION @@ -45,25 +45,8 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -ProgressAction -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -78,4 +61,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Add-WinGetSource](Add-WinGetSource.md) -[Remove-WinGetSource](Remove-WinGetSource.md) \ No newline at end of file +[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 index f2fbe3d233..834c9c96f6 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md @@ -13,8 +13,7 @@ Set WinGet settings. ## SYNTAX ``` -Set-WinGetUserSettings -UserSettings [-Merge] [-ProgressAction ] - [] +Set-WinGetUserSettings -UserSettings [-Merge] [] ``` ## DESCRIPTION @@ -52,23 +51,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -UserSettings A hashtable containing the key value pairs representing the WinGet settings. @@ -85,7 +67,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -103,4 +85,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-WinGetUserSettings](Get-WinGetUserSettings.md) -[Test-WinGetUserSettings](Test-WinGetUserSettings.md) \ No newline at end of file +[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 index 47ef55dcce..f1e8d51c19 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md @@ -13,8 +13,7 @@ Test the WinGet settings. ## SYNTAX ``` -Test-WinGetUserSettings -UserSettings [-IgnoreNotSet] [-ProgressAction ] - [] +Test-WinGetUserSettings -UserSettings [-IgnoreNotSet] [] ``` ## DESCRIPTION @@ -23,14 +22,14 @@ Tests whether the provided UserSettings matches the current WinGet settings conf ## EXAMPLES ### Example 1: Test for exact match. -```powershell -PS C:\> Test-WinGetUserSettings -UserSettings @{ installBehavior= @{ preferences= @{ scope = "user"}} } +```powershell +PS C:\> Test-WinGetUserSettings -UserSettings @{ installBehavior= @{ preferences= @{ scope = "user"}} } ``` Tests if the provided input matches the current WinGet settings configuration. This command will return False if it is not an exact match.. ### Example 2: Test only progress bar setting. -```powershell +```powershell PS C:\> Test-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } -IgnoreNotSet ``` @@ -53,23 +52,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -UserSettings A hashtable containing the key value pairs representing the WinGet settings. @@ -86,7 +68,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 @@ -104,4 +86,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-WinGetUserSettings](Get-WinGetUserSettings.md) -[Set-WinGetUserSettings](Set-WinGetUserSettings.md) \ No newline at end of file +[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 index b292ba0df6..68530fc276 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -16,14 +16,13 @@ Uninstall a WinGet Package. ``` Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ] [-Version ] [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] - [-MatchOption ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] + [-MatchOption ] [-WhatIf] [-Confirm] [] ``` ### GivenSet ``` Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ] - [[-PSCatalogPackage] ] [-Version ] [-ProgressAction ] [-WhatIf] + [[-PSCatalogPackage] ] [-Version ] [-WhatIf] [-Confirm] [] ``` @@ -44,7 +43,7 @@ This sample uninstalls the Microsoft.PowerShell package. No specific property to PS C:\> Uninstall-WinGetPackage -Id Microsoft.PowerShell ``` -This sample uninstalls the Microsoft.PowerShell package by the specifying the package identifier. +This sample uninstalls the Microsoft.PowerShell package by the specifying the package identifier. > **If more than one source is configured with the same package identifier, the user must disambiguate** @@ -53,7 +52,7 @@ This sample uninstalls the Microsoft.PowerShell package by the specifying the pa PS C:\> Uninstall-WinGetPackage -Name "PowerToys (Preview)" ``` -This sample uninstalls the PowerToys package by the specifying the package name. +This sample uninstalls the PowerToys package by the specifying the package name. ### Example 4: Uninstall a specific version of a package ```powershell @@ -175,23 +174,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -PSCatalogPackage WinGet package object. @@ -284,7 +266,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md index cfb6244fba..5f8da6e463 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -19,7 +19,7 @@ Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override [-Architecture ] [-InstallerType ] [-Locale ] [-Scope ] [-SkipDependencies] [-Version ] [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] [-MatchOption ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] + [-WhatIf] [-Confirm] [] ``` ### GivenSet @@ -28,7 +28,7 @@ Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] [-Scope ] [-SkipDependencies] [[-PSCatalogPackage] ] - [-Version ] [-ProgressAction ] [-WhatIf] [-Confirm] [] + [-Version ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -48,7 +48,7 @@ This sample updates the Microsoft.PowerShell package. No specific property to id PS C:\> Update-WinGetPackage -Id Microsoft.PowerShell ``` -This sample updates the Microsoft.PowerShell package by the specifying the package identifier. +This sample updates the Microsoft.PowerShell package by the specifying the package identifier. > **If more than one source is configured with the same package identifier, the user must disambiguate** @@ -57,7 +57,7 @@ This sample updates the Microsoft.PowerShell package by the specifying the packa PS C:\> Update-WinGetPackage -Name "PowerToys (Preview)" ``` -This sample updates the PowerToys package by the specifying the package name. +This sample updates the PowerToys package by the specifying the package name. ### Example 4: Update to a specific version of a package ```powershell @@ -316,23 +316,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ProgressAction -Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. - -This parameter was added in PowerShell 7.4. - -```yaml -Type: System.Management.Automation.ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -PSCatalogPackage WinGet package object @@ -456,7 +439,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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 From c94b752a3487c5548c6ab6761159a2a57f342041 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Wed, 31 Jul 2024 11:50:16 -0700 Subject: [PATCH 32/55] Update spelling --- .github/actions/spelling/expect.txt | 21 +++------------------ 1 file changed, 3 insertions(+), 18 deletions(-) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 99a978d40f..5f76f113e9 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -40,6 +40,7 @@ ASequence ashpatil Ashwini ASwitch +Asn ASYNCRTIMP Atest ATL @@ -56,7 +57,6 @@ BFirst bght bigcatalog BITMAPINFOHEADER - bitmask bkup blargle @@ -87,7 +87,6 @@ CLASSNOTREG CLOSEAPP cloudapp clsctx -clsid CMSG cobertura CODEOWNERS @@ -142,7 +141,6 @@ ecfr ecfrbrowse EFGH efileresource -endregion ENDSESSION EQU ERANGE @@ -151,7 +149,6 @@ errmsg ERRORONEXIT errstr ESRB -ests etest etl execustom @@ -208,6 +205,7 @@ Hostx Howto hre hresults +hrow hwnd Hyperlink IARP @@ -258,7 +256,6 @@ ldcase learnxinyminutes lhs LIBYAML -Linq liv liwpx localizationpriority @@ -331,12 +328,10 @@ mylog mysilent mysilentwithprogress mysource -nameof Nami nativehandle NBLGGH NESTEDINSTALLER -netfx netlify NETSDK Newtonsoft @@ -358,7 +353,6 @@ NOSEARCH NOSEPARATOR notalostreference NOTAPROPERTY -notmatch NOTIMPL NOTRACK NOUPDATE @@ -373,7 +367,6 @@ ofile oid omus onefuzz -ools oop opensource OPTOUT @@ -383,12 +376,10 @@ OUTOFMEMORY Outptr OVERLAPPEDWINDOW OWC -ownload packageinuse packageinusebyapplication PACL PARAMETERMAP -paramref pathparts Patil pcb @@ -420,7 +411,6 @@ pri PRIMARYKEY processthreads productcode -proga PRODUCTICON proxystub pscustomobject @@ -491,6 +481,7 @@ servercertificate setmetadatabymanifestid SETTINGCHANGE SETTINGMAPPING +sfs sfsclient SHCONTF shellapi @@ -537,7 +528,6 @@ taskhostw tcs TEMPDIRECTORY Templating -templating temppath testexampleinstaller thiscouldbeapc @@ -548,7 +538,6 @@ tombstoned transitioning trimstart ttl -typeparam typedef UCase ucasemap @@ -563,7 +552,6 @@ uninstallation uninstaller uninstallprevious uninstalls -Unk unknwn Unknwnbase UNMARSHALING @@ -580,9 +568,6 @@ userprofile uwp VALUENAMECASE vclib -VERSI -VERSIE -versioned versioned VERSIONINFO vns From 1fb3173d2fd87a2ca45f05fd4d97329590b11416 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Wed, 31 Jul 2024 11:54:03 -0700 Subject: [PATCH 33/55] spelling --- .github/actions/spelling/expect.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 5f76f113e9..b57b1a32ee 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -527,7 +527,6 @@ TARG taskhostw tcs TEMPDIRECTORY -Templating temppath testexampleinstaller thiscouldbeapc From 3de666da688aa4dedfed3c8a63b85bc1abf2f669 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Wed, 31 Jul 2024 13:46:39 -0700 Subject: [PATCH 34/55] fix spelling --- .github/actions/spelling/expect.txt | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index b57b1a32ee..1d867e311a 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -454,7 +454,6 @@ Roblox ronomon Roronoa rosoft -rowids rowid roy RRF @@ -577,7 +576,6 @@ wcex WDAG webpages Webserver -websites website wesome wfsopen From d98528f3fc9f15328afb92f5a934292675450d09 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Wed, 31 Jul 2024 13:46:53 -0700 Subject: [PATCH 35/55] update spelling --- .../Microsoft.WinGet.Client/Assert-WinGetPackageManager.md | 2 +- .../Help/Microsoft.WinGet.Client/Find-WinGetPackage.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md index 93509bdea5..340530014e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md @@ -51,7 +51,7 @@ If the latest version of WinGet correlated with the Microsoft.WinGet.Client modu PS C:\> Assert-WinGetPackageManager -IncludePreRelease ``` -If the a preview version of WinGet correlated with the Microsoft.WinGet.Client module is installed correctly this will return without error. +If a preview version of WinGet correlated with the Microsoft.WinGet.Client module is installed correctly this will return without error. ### Example 4: Check if specific version is installed diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md index 2eb5dad68f..e4d38c8b9e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -29,7 +29,7 @@ Searches configured sources for packages. PS C:\> Find-WinGetPackage PowerShell ``` -Search for PowerShell. The default behavior spans all configured sources and performs a case insensitive substring match across package identifier, package name, package moniker, and package tags. +Search for PowerShell. The default behavior spans all configured sources and performs a case-insensitive substring match across package identifier, package name, package moniker, and package tags. ### Example 2: Search for Microsoft.PowerShell by id @@ -37,7 +37,7 @@ Search for PowerShell. The default behavior spans all configured sources and per PS C:\> Find-WinGetPackage -Id Microsoft.PowerShell ``` -Search for Microsoft.PowerShell by package identifier. The default behavior spans all configured sources and performs a case insensitive substring match across package identifiers. +Search for Microsoft.PowerShell by package identifier. The default behavior spans all configured sources and performs a case-insensitive substring match across package identifiers. ### Example 3: Search for Microsoft.PowerShell by exact id @@ -45,7 +45,7 @@ Search for Microsoft.PowerShell by package identifier. The default behavior span PS C:\> Find-WinGetPackage -Id Microsoft.PowerShell -MatchOption Equals ``` -Search for Microsoft.PowerShell by exact package identifier. This search spans all configured sources and performs a case sensitive match across package identifiers. +Search for Microsoft.PowerShell by exact package identifier. This search spans all configured sources and performs a case-sensitive match across package identifiers. ## PARAMETERS From aed27783119faef38e51b51bc741998ac618b2fd Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 1 Aug 2024 08:35:47 -0700 Subject: [PATCH 36/55] update Add-WinGetSource --- .../Help/Microsoft.WinGet.Client/Add-WinGetSource.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index 10f5483f19..11b5655f98 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Add-WinGetSource ## SYNOPSIS -Add a new source. +Adds a new source. ## SYNTAX @@ -17,7 +17,7 @@ Add-WinGetSource -Name -Argument [-Type ] [ Date: Thu, 1 Aug 2024 08:41:17 -0700 Subject: [PATCH 37/55] Update descriptions to present tense --- .../Disable-WinGetSetting.md | 2 +- .../Enable-WinGetSetting.md | 2 +- .../Find-WinGetPackage.md | 2 +- .../Get-WinGetPackage.md | 4 ++-- .../Get-WinGetSettings.md | 2 +- .../Get-WinGetSource.md | 2 +- .../Get-WinGetUserSettings.md | 4 ++-- .../Get-WinGetVersion.md | 4 ++-- .../Install-WinGetPackage.md | 4 ++-- .../Microsoft.WinGet.Client.md | 24 +++++++++---------- .../Remove-WinGetSource.md | 4 ++-- .../Reset-WinGetSource.md | 2 +- .../Set-WinGetUserSettings.md | 4 ++-- .../Test-WinGetUserSettings.md | 2 +- .../Uninstall-WinGetPackage.md | 2 +- 15 files changed, 32 insertions(+), 32 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md index ecdc164353..99c4dfc6c9 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -38,7 +38,7 @@ Administrator Settings: PS C:\> Disable-WinGetSetting -Name LocalManifestFiles ``` -Disable the use of local manifest files. +Disables the use of local manifest files. ## PARAMETERS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md index f0cb9047a7..586c771972 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md @@ -37,7 +37,7 @@ Administrator Settings: PS C:\> Enable-WinGetSetting -Name LocalManifestFiles ``` -Enable the use of local manifest files. +Enables the use of local manifest files. ## PARAMETERS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md index e4d38c8b9e..481852cd58 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -29,7 +29,7 @@ Searches configured sources for packages. PS C:\> Find-WinGetPackage PowerShell ``` -Search for PowerShell. The default behavior spans all configured sources and performs a case-insensitive substring match across package identifier, package name, package moniker, and package tags. +Searches for PowerShell. The default behavior spans all configured sources and performs a case-insensitive substring match across package identifier, package name, package moniker, and package tags. ### Example 2: Search for Microsoft.PowerShell by id diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md index 896dbc81f6..04fb3af672 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-WinGetPackage ## SYNOPSIS -List installed packages. +Lists installed packages. ## SYNTAX @@ -31,7 +31,7 @@ Lists installed packages. Get-WinGetPackage ``` -Displays installed packages. +Lists installed packages. ## PARAMETERS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md index 6c94b6c1d8..0a0bd55546 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-WinGetSettings ## SYNOPSIS -Get WinGet settings. +Gets WinGet settings. ## SYNTAX diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md index 8b9ed88161..b32f1b2a3e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-WinGetSource ## SYNOPSIS -List configured WinGet sources. +Lists configured WinGet sources. ## SYNTAX diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md index 1f5be9f951..2f3f732d6a 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-WinGetUserSettings ## SYNOPSIS -Get user settings for WinGet. +Gets user settings for WinGet. ## SYNTAX @@ -26,7 +26,7 @@ Get user settings for WinGet. PS C:\> Get-WinGetUserSettings ``` -Get the user settings from the user's settings.json file. +Gets the user settings from the user's settings.json file. ## PARAMETERS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md index ee01a94def..f79f72b8ea 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-WinGetVersion ## SYNOPSIS -Get the installed version of WinGet. +Gets the installed version of WinGet. ## SYNTAX @@ -26,7 +26,7 @@ Get the installed version of WinGet. PS C:\> Get-WinGetVersion ``` -Get the installed version of WinGet. +Gets the installed version of WinGet. ## PARAMETERS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 4d55721f34..7d839f41c6 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Install-WinGetPackage ## SYNOPSIS -Install a WinGet Package. +Installs a WinGet Package. ## SYNTAX @@ -32,7 +32,7 @@ Install-WinGetPackage [-Mode ] [-Override ] [-Cust ``` ## DESCRIPTION -Install a WinGet package from a configured source. +Installs a WinGet package from a configured source. ## EXAMPLES diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index 7487e5a3b1..30f9726771 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -12,7 +12,7 @@ Microsoft WinGet Client Module for the Windows Package Manager ## Microsoft.WinGet.Client Cmdlets ### [Add-WinGetSource](Add-WinGetSource.md) -Add a new WinGet source. +Adds a new WinGet source. ### [Assert-WinGetPackageManager](Assert-WinGetPackageManager.md) Verifies WinGet is installed properly. @@ -30,40 +30,40 @@ Downloads a package. Searches configured sources for packages. ### [Get-WinGetPackage](Get-WinGetPackage.md) -List installed packages. +Gets installed packages. ### [Get-WinGetSettings](Get-WinGetSettings.md) -Get WinGet settings. +Gets WinGet settings. ### [Get-WinGetSource](Get-WinGetSource.md) -List configured WinGet sources. +Gets configured WinGet sources. ### [Get-WinGetUserSettings](Get-WinGetUserSettings.md) -Get user settings for WinGet. +Gets user settings for WinGet. ### [Get-WinGetVersion](Get-WinGetVersion.md) -Get the installed version of WinGet. +Gets the installed version of WinGet. ### [Install-WinGetPackage](Install-WinGetPackage.md) Install a WinGet Package. ### [Remove-WinGetSource](Remove-WinGetSource.md) -Remove a configured source. +Removes a configured source. ### [Repair-WinGetPackageManager](Repair-WinGetPackageManager.md) Repairs the WinGet client. ### [Reset-WinGetSource](Reset-WinGetSource.md) -Reset default WinGet sources. +Resets default WinGet sources. ### [Set-WinGetUserSettings](Set-WinGetUserSettings.md) -Set WinGet settings. +Sets WinGet settings. ### [Test-WinGetUserSettings](Test-WinGetUserSettings.md) -Test the WinGet settings. +Tests WinGet settings. ### [Uninstall-WinGetPackage](Uninstall-WinGetPackage.md) -Uninstall a WinGet Package. +Uninstalls a WinGet Package. ### [Update-WinGetPackage](Update-WinGetPackage.md) -Update a WinGet Package. +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 index e49aec4a7b..974342073e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Remove-WinGetSource ## SYNOPSIS -Remove a configured source. +Removes a configured source. ## SYNTAX @@ -17,7 +17,7 @@ Remove-WinGetSource -Name [] ``` ## DESCRIPTION -Remove a configured source. +Removes a configured source. ## EXAMPLES diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md index 12e2bca850..e2d1c24688 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Reset-WinGetSource ## SYNOPSIS -Reset default WinGet sources. +Resets default WinGet sources. ## SYNTAX diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md index 834c9c96f6..f24e668522 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Set-WinGetUserSettings ## SYNOPSIS -Set WinGet settings. +Sets WinGet settings. ## SYNTAX @@ -17,7 +17,7 @@ Set-WinGetUserSettings -UserSettings [-Merge] [] ``` ## DESCRIPTION -Set the behavior of various WinGet settings. For more information about WinGet settings, visit https://aka.ms/winget-settings. +Sets the behavior of various WinGet settings. For more information about WinGet settings, visit https://aka.ms/winget-settings. ## EXAMPLES diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md index f1e8d51c19..292fb8e749 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Test-WinGetUserSettings ## SYNOPSIS -Test the WinGet settings. +Tests WinGet settings. ## SYNTAX diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md index 68530fc276..0335a325c2 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Uninstall-WinGetPackage ## SYNOPSIS -Uninstall a WinGet Package. +Uninstalls a WinGet Package. ## SYNTAX From 1f92ce862400271def035cadace5c40eabc8de21 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 1 Aug 2024 10:50:23 -0700 Subject: [PATCH 38/55] Initial editorial improvements and markdownlint --- .../Add-WinGetSource.md | 29 +++-- .../Uninstall-WinGetPackage.md | 24 +++- src/PowerShell/Help/markdownlint.yaml | 117 ++++++++++++++++++ 3 files changed, 158 insertions(+), 12 deletions(-) create mode 100644 src/PowerShell/Help/markdownlint.yaml diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index 11b5655f98..c68d1592d8 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -17,27 +17,26 @@ Add-WinGetSource -Name -Argument [-Type ] [ Add-WinGetSource -Name mysource -Argument https://contoso.com/ -Type Microsoft.Rest +Add-WinGetSource -Name mysource -Argument https://contoso.com/ -Type Microsoft.Rest ``` -This example adds a new REST based source to WinGet named "mysource" with the root URL https://contoso.com/. - -> **This example is illustrative and will not succeed because WinGet will not add a source that does not properly respond to the WinGet REST API** +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 the source. - -> **Before a source can be added, WinGet will verify the URL or UNC is reachable and provides the proper response.** +The URL or UNC of WinGet source. The source must respond with the WinGet REST source API. ```yaml Type: System.String @@ -52,7 +51,8 @@ Accept wildcard characters: False ``` ### -Name -The name to identify the source by. + +The name used to identify the WinGet source. ```yaml Type: System.String @@ -67,7 +67,9 @@ Accept wildcard characters: False ``` ### -Type -Type of the source. Most sources will be "Microsoft.Rest". The WinGet community repository is "Microsoft.PreIndexed.Package". + +The type of the WinGet source. Most sources will be `Microsoft.Rest`. The WinGet community +repository is `Microsoft.PreIndexed.Package`. ```yaml Type: System.String @@ -82,7 +84,11 @@ 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). + +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 @@ -91,6 +97,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md index 0335a325c2..fc4aa70e97 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -13,6 +13,7 @@ Uninstalls a WinGet Package. ## SYNTAX ### FoundSet (Default) + ``` Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ] [-Version ] [-Id ] [-Name ] [-Moniker ] [-Source ] [[-Query] ] @@ -20,6 +21,7 @@ Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ``` ### GivenSet + ``` Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ] [[-PSCatalogPackage] ] [-Version ] [-WhatIf] @@ -27,11 +29,13 @@ Uninstall-WinGetPackage [-Mode ] [-Force] [-Log ``` ## DESCRIPTION + Uninstalls the selected package found by searching the installed packages list. ## EXAMPLES ### Example 1: Uninstall a package using a query + ```powershell PS C:\> Uninstall-WinGetPackage Microsoft.PowerShell ``` @@ -39,6 +43,7 @@ PS C:\> Uninstall-WinGetPackage Microsoft.PowerShell This sample uninstalls the Microsoft.PowerShell package. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring the user to pass "-Id". ### Example 2: Uninstall a package by Id + ```powershell PS C:\> Uninstall-WinGetPackage -Id Microsoft.PowerShell ``` @@ -48,6 +53,7 @@ This sample uninstalls the Microsoft.PowerShell package by the specifying the pa > **If more than one source is configured with the same package identifier, the user must disambiguate** ### Example 3: Uninstall a package by Name + ```powershell PS C:\> Uninstall-WinGetPackage -Name "PowerToys (Preview)" ``` @@ -55,6 +61,7 @@ PS C:\> 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 PS C:\> Uninstall-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 ``` @@ -64,6 +71,7 @@ This sample uninstalls the Microsoft.PowerShell package version 7.4.4.0. No spec ## PARAMETERS ### -Force + Force the uninstall to run. ```yaml @@ -79,6 +87,7 @@ Accept wildcard characters: False ``` ### -Id + Specify package identifier ```yaml @@ -94,6 +103,7 @@ Accept wildcard characters: False ``` ### -Log + Specify log location for uninstall. > **Note: Not all uninstallers support this option.** @@ -111,6 +121,7 @@ Accept wildcard characters: False ``` ### -MatchOption + Specify the match type to use. ```yaml @@ -127,6 +138,7 @@ Accept wildcard characters: False ``` ### -Mode + Specify the installer output mode. Options are "Default", "Silent", and "Interactive". > **Note: Not all uninstallers support all modes.** @@ -145,6 +157,7 @@ Accept wildcard characters: False ``` ### -Moniker + Specify the moniker. ```yaml @@ -160,7 +173,9 @@ Accept wildcard characters: False ``` ### -Name -Specify the name. + +Specify the WinGet package name. This should be the full package name. The name should be in +quotation marks if there is a space in the name. ```yaml Type: System.String @@ -175,6 +190,7 @@ Accept wildcard characters: False ``` ### -PSCatalogPackage + WinGet package object. ```yaml @@ -190,6 +206,7 @@ Accept wildcard characters: False ``` ### -Query + Search string. Wildcards are not supported. ```yaml @@ -205,6 +222,7 @@ Accept wildcard characters: False ``` ### -Source + Specify configured WinGet source. ```yaml @@ -220,6 +238,7 @@ Accept wildcard characters: False ``` ### -Version + Specify the version. ```yaml @@ -235,6 +254,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -250,6 +270,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -266,6 +287,7 @@ 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 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 From a95f8453aac6ffeb18a9b2a7af0defe5402bb6f5 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 1 Aug 2024 11:30:14 -0700 Subject: [PATCH 39/55] fix spelling --- .github/actions/spelling/expect.txt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 1d867e311a..0c10474461 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -45,6 +45,7 @@ ASYNCRTIMP Atest ATL AType +atx AUrl auxdata azcopy @@ -61,6 +62,7 @@ bitmask bkup blargle blockedbypolicy +blockquote blogs bluetooth Bomgar @@ -91,6 +93,7 @@ CMSG cobertura CODEOWNERS codepage +codesnippet COINIT COMGLB commandline @@ -130,6 +133,7 @@ diskfull displaycatalog DMC dnld +docsmd Dobbeleer DONOT dsc @@ -248,6 +252,7 @@ jsoncpp JToken JValue Kaido +kbd KNOWNFOLDERID kool ktf @@ -290,6 +295,7 @@ maclachlan MAJORVERSION malware mapdatafolding +markdownlint Maxed MAXLENGTH maxvalue @@ -472,12 +478,14 @@ schematab Scm sddl SECUREFILEPATH +securelinks secureobject securestring seof servercert servercertificate setmetadatabymanifestid +settext SETTINGCHANGE SETTINGMAPPING sfs From c08c4b0f43ee26ad9ae5072ba28e1ab9aea7843a Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 1 Aug 2024 11:42:01 -0700 Subject: [PATCH 40/55] spell exclude markdownlint file --- .github/actions/spelling/excludes.txt | 1 + .../Assert-WinGetPackageManager.md | 13 ++++++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) 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/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md index 340530014e..eed1b9aedc 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md @@ -13,19 +13,25 @@ Verifies WinGet is installed properly. ## SYNTAX ### IntegrityVersionSet (Default) + ``` Assert-WinGetPackageManager [-Version ] [] ``` ### IntegrityLatestSet + ``` Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [] ``` ## DESCRIPTION + Verifies WinGet is installed properly. ->**This does not ensure the latest version of WinGet is installed. This just verifies the current installed version correlated with the Microsoft.WinGet.Client module is functional.** +> [!NOTE] +> Information the user should notice even if skimming>**This does not ensure the latest version of +> WinGet is installed. This just verifies the current installed version correlated with the +> Microsoft.WinGet.Client module is functional.** ## EXAMPLES @@ -64,6 +70,7 @@ If the specified version of WinGet correlated with the Microsoft.WinGet.Client m ## PARAMETERS ### -IncludePreRelease + Includes preview versions of WinGet ```yaml @@ -79,6 +86,7 @@ Accept wildcard characters: False ``` ### -Latest + Verifies the latest version of WinGet correlated with the Microsoft.WinGet.Client module is installed ```yaml @@ -94,6 +102,7 @@ Accept wildcard characters: False ``` ### -Version + Verifies a specific version of WinGet is installed. ```yaml @@ -109,6 +118,7 @@ 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 @@ -120,6 +130,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS From fe3b74b95dc39411000dea67b2d9a68be6a6875b Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 1 Aug 2024 13:44:02 -0700 Subject: [PATCH 41/55] Initial pass at formatting --- .../Assert-WinGetPackageManager.md | 37 +++++---- .../Disable-WinGetSetting.md | 13 ++- .../Enable-WinGetSetting.md | 17 +++- .../Export-WinGetPackage.md | 80 +++++++++++++++---- .../Find-WinGetPackage.md | 34 ++++++-- .../Get-WinGetPackage.md | 16 +++- .../Get-WinGetSettings.md | 18 ++++- .../Get-WinGetSource.md | 11 ++- .../Get-WinGetUserSettings.md | 12 ++- .../Get-WinGetVersion.md | 10 ++- .../Install-WinGetPackage.md | 51 ++++++++++-- .../Microsoft.WinGet.Client.md | 2 +- .../Remove-WinGetSource.md | 15 +++- .../Repair-WinGetPackageManager.md | 28 +++++-- .../Reset-WinGetSource.md | 17 +++- .../Set-WinGetUserSettings.md | 16 +++- .../Test-WinGetUserSettings.md | 19 +++-- .../Uninstall-WinGetPackage.md | 26 +++--- .../Update-WinGetPackage.md | 52 ++++++++++-- 19 files changed, 372 insertions(+), 102 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md index eed1b9aedc..235a5850e8 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md @@ -29,49 +29,52 @@ Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [] Verifies WinGet is installed properly. > [!NOTE] -> Information the user should notice even if skimming>**This does not ensure the latest version of -> WinGet is installed. This just verifies the current installed version correlated with the -> Microsoft.WinGet.Client module is functional.** +> This does not ensure the latest version of WinGet is installed. This just verifies the current +> installed version correlated with the Microsoft.WinGet.Client module is functional. ## EXAMPLES ### Example 1: Default usage ```powershell -PS C:\> Assert-WinGetPackageManager +Assert-WinGetPackageManager ``` -If the current version of WinGet is installed correctly this will return without error. +If the current version of WinGet is installed correctly this will return without error. This does +not upgrade WinGet to the latest version. ### Example 2: Check if latest stable version is installed ```powershell -PS C:\> Assert-WinGetPackageManager -Latest +Assert-WinGetPackageManager -Latest ``` -If the latest version of WinGet correlated with the Microsoft.WinGet.Client module is installed correctly this will return without error. +If the latest version of WinGet correlated with the Microsoft.WinGet.Client module is installed +correctly this will return without error. ### Example 3: Check if latest preview version is installed ```powershell -PS C:\> Assert-WinGetPackageManager -IncludePreRelease +Assert-WinGetPackageManager -IncludePreRelease ``` -If a preview version of WinGet correlated with the Microsoft.WinGet.Client module is installed correctly this will return without error. +If a preview version of WinGet correlated with the Microsoft.WinGet.Client module is installed +correctly this will return without error. ### Example 4: Check if specific version is installed ```powershell -PS C:\> Assert-WinGetPackageManager -Version v1.8.1911 +Assert-WinGetPackageManager -Version v1.8.1911 ``` -If the specified version of WinGet correlated with the Microsoft.WinGet.Client module is installed correctly this will return without error. +If the specified version of WinGet correlated with the Microsoft.WinGet.Client module is installed +correctly this will return without error. ## PARAMETERS ### -IncludePreRelease -Includes preview versions of WinGet +Includes preview versions of WinGet. ```yaml Type: System.Management.Automation.SwitchParameter @@ -87,7 +90,8 @@ Accept wildcard characters: False ### -Latest -Verifies the latest version of WinGet correlated with the Microsoft.WinGet.Client module is installed +Verifies the latest version of WinGet correlated with the Microsoft.WinGet.Client module is +installed. ```yaml Type: System.Management.Automation.SwitchParameter @@ -119,7 +123,10 @@ 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). +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 @@ -134,3 +141,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 index 99c4dfc6c9..b40c05c950 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -17,6 +17,7 @@ Disable-WinGetSetting [-Name] [] ``` ## DESCRIPTION + Disables an administrative setting. Requires administrator access. Administrator Settings default to "Disabled" and may be controlled by Group Policy Objects. @@ -35,7 +36,7 @@ Administrator Settings: ### Example 1: Disable the use of local manifest files ```powershell -PS C:\> Disable-WinGetSetting -Name LocalManifestFiles +Disable-WinGetSetting -Name LocalManifestFiles ``` Disables the use of local manifest files. @@ -43,7 +44,8 @@ Disables the use of local manifest files. ## PARAMETERS ### -Name -The name of the administrator setting + +The name of the WinGet administrator setting ```yaml Type: System.String @@ -58,7 +60,11 @@ 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). + +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 @@ -67,6 +73,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md index 586c771972..fc31d7a55f 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md @@ -8,7 +8,8 @@ schema: 2.0.0 # Enable-WinGetSetting ## SYNOPSIS -Enables an administrative setting. + +Enables WinGet administrative settings. ## SYNTAX @@ -17,6 +18,7 @@ Enable-WinGetSetting [-Name] [] ``` ## DESCRIPTION + Enables an administrative setting. Requires administrator access. Administrator Settings default to "Disabled" and may be controlled by Group Policy Objects. @@ -33,8 +35,9 @@ Administrator Settings: ## EXAMPLES ### Example 1 + ```powershell -PS C:\> Enable-WinGetSetting -Name LocalManifestFiles +Enable-WinGetSetting -Name LocalManifestFiles ``` Enables the use of local manifest files. @@ -42,7 +45,8 @@ Enables the use of local manifest files. ## PARAMETERS ### -Name -The name of the administrator setting + +The name of the WinGet administrator setting ```yaml Type: System.String @@ -57,7 +61,11 @@ 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). + +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 @@ -66,6 +74,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index 936fd05560..512a4c404a 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -13,6 +13,7 @@ Downloads a package. ## SYNTAX ### FoundSet (Default) + ``` Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] @@ -22,6 +23,7 @@ Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] ``` ### GivenSet + ``` Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] [-Architecture ] [-InstallerType ] [-Locale ] @@ -30,21 +32,34 @@ Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] ``` ## DESCRIPTION -Downloads a package installer from the pipeline or from a configured source. The package manifest as well as dependencies and their manifests will be included. The default directory if not specified is the Downloads folder. + +Downloads a package installer from the pipeline or from a configured source. The package manifest as +well as dependencies and their manifests will be included. The default directory if not specified is +the Downloads folder. + +If the package is coming from the Microsoft Store, the user initiating the Offline License retrieval +needs to be a member of one of the following Roles in Azure: Global Administrator, User +Administrator, or License Administrator. If the user is a member of any of those groups, they will +receive a copy of the license file. ## EXAMPLES ### Example 1: Download Microsoft.PowerShell to the default location + ```powershell -PS C:\> Export-WinGetPackage -Id Microsoft.PowerShell +Export-WinGetPackage -Id Microsoft.PowerShell ``` -This example will download the latest available version of the Microsoft.PowerShell installer (for the current system and default scope) and the manifest to a folder (named by concatenating the package identifier with an underscore and the version number) in the Downloads directory. +This example will download the latest available version of the Microsoft.PowerShell installer (for +the current system and default scope) and the manifest to a folder (named by concatenating the +package identifier with an underscore and the version number) in the Downloads directory. ## PARAMETERS ### -AllowHashMismatch -Allow the download even if the SHA256 hash does not match + +Allow the download even if 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 @@ -59,7 +74,8 @@ Accept wildcard characters: False ``` ### -Architecture -Specify the architecture for the installer + +Specify the architecture for the WinGet package installer ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture @@ -75,6 +91,7 @@ Accept wildcard characters: False ``` ### -DownloadDirectory + Specify the directory for the download ```yaml @@ -90,7 +107,8 @@ Accept wildcard characters: False ``` ### -Id -Specify the package identifier + +Specify the WinGet package identifier ```yaml Type: System.String @@ -105,7 +123,11 @@ Accept wildcard characters: False ``` ### -InstallerType -Specify the installer type + +Specify the installer type for the WinGet package installer + +> [!NOTE] +> The installer type must be available in the WinGet package manifest. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallerType @@ -121,7 +143,11 @@ Accept wildcard characters: False ``` ### -Locale -Specify the installer locale + +Specify the installer locale for the WinGet package installer locale + +> [!NOTE] +> The locale must be available in the WinGet package manifest. ```yaml Type: System.String @@ -136,7 +162,8 @@ Accept wildcard characters: False ``` ### -MatchOption -Specify the match option for a package query + +Specify the match option for a WinGet package query ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption @@ -152,7 +179,8 @@ Accept wildcard characters: False ``` ### -Moniker -Specify the moniker + +Specify the WinGet package moniker ```yaml Type: System.String @@ -167,7 +195,8 @@ Accept wildcard characters: False ``` ### -Name -Specify the package name + +Specify the WinGet package name ```yaml Type: System.String @@ -182,6 +211,7 @@ Accept wildcard characters: False ``` ### -PSCatalogPackage + Specify PSCatalogPackage ```yaml @@ -197,7 +227,10 @@ Accept wildcard characters: False ``` ### -Query -Search string for package + +Search string for WinGet package. The query parameter will be used to search across multiple +properties in a WinGet package manifest. Fields include the package name, package identifier, +moniker, and tags. ```yaml Type: System.String[] @@ -212,7 +245,11 @@ Accept wildcard characters: False ``` ### -Scope -Specify installer scope + +Specify WinGet package installer scope + +> [!NOTE] +> The installer scope must be available in the WinGet package manifest. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallScope @@ -228,7 +265,8 @@ Accept wildcard characters: False ``` ### -SkipDependencies -Specify main package without dependencies + +Specifes the WinGet package dependencies should not be downloaded. ```yaml Type: System.Management.Automation.SwitchParameter @@ -243,7 +281,8 @@ Accept wildcard characters: False ``` ### -Source -Specify WinGet source + +Specifies WinGet source. ```yaml Type: System.String @@ -258,7 +297,8 @@ Accept wildcard characters: False ``` ### -Version -Specify package version + +Specifies the WinGet package version to download ```yaml Type: System.String @@ -273,6 +313,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -288,6 +329,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -304,7 +346,11 @@ 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). + +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md index 481852cd58..9230c16529 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -19,6 +19,7 @@ Find-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id Find-WinGetPackage PowerShell +Find-WinGetPackage PowerShell ``` -Searches for PowerShell. The default behavior spans all configured sources and performs a case-insensitive substring match across package identifier, package name, package moniker, and package tags. +Searches for PowerShell. The default behavior spans all configured sources and performs a +case-insensitive substring match across package identifier, package name, package moniker, and +package tags. ### Example 2: Search for Microsoft.PowerShell by id ```powershell -PS C:\> Find-WinGetPackage -Id Microsoft.PowerShell +Find-WinGetPackage -Id Microsoft.PowerShell ``` -Search for Microsoft.PowerShell by package identifier. The default behavior spans all configured sources and performs a case-insensitive substring match across package identifiers. +Search for Microsoft.PowerShell by package identifier. The default behavior spans all configured +sources and performs a case-insensitive substring match across package identifiers. ### Example 3: Search for Microsoft.PowerShell by exact id ```powershell -PS C:\> Find-WinGetPackage -Id Microsoft.PowerShell -MatchOption Equals +Find-WinGetPackage -Id Microsoft.PowerShell -MatchOption Equals ``` -Search for Microsoft.PowerShell by exact package identifier. This search spans all configured sources and performs a case-sensitive match across package identifiers. +Search for Microsoft.PowerShell by exact package identifier. This search spans all configured +sources and performs a case-sensitive match across package identifiers. ## PARAMETERS ### -Command -Specifies command used to run package + +Specifies command used to run the package ```yaml Type: System.String @@ -65,6 +71,7 @@ Accept wildcard characters: False ``` ### -Count + Specifies maximum number of results to return ```yaml @@ -80,6 +87,7 @@ Accept wildcard characters: False ``` ### -Id + Specifies search by package identifier ```yaml @@ -95,6 +103,7 @@ Accept wildcard characters: False ``` ### -MatchOption + Specifies matching logic for search ```yaml @@ -111,6 +120,7 @@ Accept wildcard characters: False ``` ### -Moniker + Specifies package moniker ```yaml @@ -126,6 +136,7 @@ Accept wildcard characters: False ``` ### -Name + Specifies package name ```yaml @@ -141,6 +152,7 @@ Accept wildcard characters: False ``` ### -Query + Specifies query string to search for ```yaml @@ -156,6 +168,7 @@ Accept wildcard characters: False ``` ### -Source + Specifies WinGet source for search ```yaml @@ -171,6 +184,7 @@ Accept wildcard characters: False ``` ### -Tag + Specifies tag to search for ```yaml @@ -186,7 +200,11 @@ 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). + +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md index 04fb3af672..8f76dd4eae 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md @@ -19,6 +19,7 @@ Get-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id **Packages with leading "ARP" or "MSIX" are installed on the device, but not correlated with any configured source. @@ -36,6 +37,7 @@ Lists installed packages. ## PARAMETERS ### -Command + Filter results by their command ```yaml @@ -51,6 +53,7 @@ Accept wildcard characters: False ``` ### -Count + Limit the number of results ```yaml @@ -66,6 +69,7 @@ Accept wildcard characters: False ``` ### -Id + Filter results by their package identifier ```yaml @@ -81,6 +85,7 @@ Accept wildcard characters: False ``` ### -MatchOption + Specify the matching logic ```yaml @@ -97,6 +102,7 @@ Accept wildcard characters: False ``` ### -Moniker + Filter results by package moniker ```yaml @@ -112,6 +118,7 @@ Accept wildcard characters: False ``` ### -Name + Filter results by package name ```yaml @@ -127,6 +134,7 @@ Accept wildcard characters: False ``` ### -Query + Specifies query string to search for ```yaml @@ -142,6 +150,7 @@ Accept wildcard characters: False ``` ### -Source + Specify the source ```yaml @@ -157,6 +166,7 @@ Accept wildcard characters: False ``` ### -Tag + Filter by Tag ```yaml @@ -172,7 +182,11 @@ 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). + +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md index 0a0bd55546..ff765add69 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -17,20 +17,25 @@ Get-WinGetSettings [-AsPlainText] [] ``` ## DESCRIPTION -Get WinGet settings. This includes the user settings file, administrator settings, and the settings schema. For more information about WinGet settings, visit https://aka.ms/winget-settings. + +Get WinGet settings. This includes the user settings file, administrator settings, and the settings +schema. For more information about WinGet settings, visit `https://aka.ms/winget-settings`. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> Get-WinGetSettings +Get-WinGetSettings ``` -This will display the user settings file location, the administrator settings, and the settings schema URL. +This will display the user settings file location, the administrator settings, and the settings +schema URL. ## PARAMETERS ### -AsPlainText + Output results as plain text ```yaml @@ -46,7 +51,11 @@ 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). + +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 @@ -55,6 +64,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md index b32f1b2a3e..6ecc9e2575 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md @@ -17,13 +17,15 @@ Get-WinGetSource [[-Name] ] [] ``` ## DESCRIPTION + List configured WinGet sources. ## EXAMPLES ### Example 1: Default example + ```powershell -PS C:\> Get-WinGetSource +Get-WinGetSource ``` This will list the configured WinGet sources. The two default sources are "msstore" and "winget". @@ -31,6 +33,7 @@ This will list the configured WinGet sources. The two default sources are "mssto ## PARAMETERS ### -Name + Filter by WinGet source name ```yaml @@ -46,7 +49,11 @@ 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). + +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md index 2f3f732d6a..bd4577bcaf 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md @@ -17,21 +17,27 @@ Get-WinGetUserSettings [] ``` ## DESCRIPTION + Get user settings for WinGet. ## EXAMPLES ### Example 1: Default + ```powershell -PS C:\> Get-WinGetUserSettings +Get-WinGetUserSettings ``` -Gets the user settings from the user's settings.json file. +Gets the WinGet user settings from the user's settings.json file. ## 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). + +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md index f79f72b8ea..21fdf1801f 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md @@ -17,13 +17,15 @@ Get-WinGetVersion [] ``` ## DESCRIPTION + Get the installed version of WinGet. ## EXAMPLES ### Example 1: Default example + ```powershell -PS C:\> Get-WinGetVersion +Get-WinGetVersion ``` Gets the installed version of WinGet. @@ -31,7 +33,11 @@ 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). + +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 7d839f41c6..39a6db5a9f 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -13,6 +13,7 @@ Installs a WinGet Package. ## SYNTAX ### FoundSet (Default) + ``` Install-WinGetPackage [-Mode ] [-Override ] [-Custom ] [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] @@ -23,6 +24,7 @@ Install-WinGetPackage [-Mode ] [-Override ] [-Cust ``` ### GivenSet + ``` Install-WinGetPackage [-Mode ] [-Override ] [-Custom ] [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] @@ -32,20 +34,25 @@ Install-WinGetPackage [-Mode ] [-Override ] [-Cust ``` ## DESCRIPTION + Installs a WinGet package from a configured source. ## EXAMPLES ### Example 1: Install a package using a query + ```powershell -PS C:\> Install-WinGetPackage Microsoft.PowerShell +Install-WinGetPackage Microsoft.PowerShell ``` -This sample installs the Microsoft.PowerShell package. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring the user to pass "-Id". +This sample installs the Microsoft.PowerShell package. No specific property to identify the query +string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring +the user to pass "-Id". ### Example 2: Install a package by Id + ```powershell -PS C:\> Install-WinGetPackage -Id Microsoft.PowerShell +Install-WinGetPackage -Id Microsoft.PowerShell ``` This sample installs the Microsoft.PowerShell package by the specifying the package identifier. @@ -53,22 +60,26 @@ This sample installs the Microsoft.PowerShell package by the specifying the pack > **If more than one source is configured with the same package identifier, the user must disambiguate** ### Example 3: Install a package by Name + ```powershell -PS C:\> Install-WinGetPackage -Name "PowerToys (Preview)" +Install-WinGetPackage -Name "PowerToys (Preview)" ``` This sample installs the PowerToys package by the specifying the package name. ### Example 4: Install a specific version of a package + ```powershell -PS C:\> Install-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 +Install-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 ``` -This sample installs the Microsoft.PowerShell package version 7.4.4.0. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. +This sample installs the Microsoft.PowerShell package version 7.4.4.0. No specific property to +identify the query string "Microsoft.PowerShell" as a package identifier. ## PARAMETERS ### -AllowHashMismatch + Allow the install to continue even if the SHA256 has does not match. ```yaml @@ -84,6 +95,7 @@ Accept wildcard characters: False ``` ### -Architecture + Specify the hardware architecture for the installer. ```yaml @@ -100,6 +112,7 @@ Accept wildcard characters: False ``` ### -Custom + Arguments to be passed to the installer in addition to those in the manifest. ```yaml @@ -115,6 +128,7 @@ Accept wildcard characters: False ``` ### -Force + Force the installer to run even when other checks WinGet would perform would prevent this action. ```yaml @@ -130,6 +144,7 @@ Accept wildcard characters: False ``` ### -Header + Custom value to be passed via HTTP header to WinGet REST sources. ```yaml @@ -145,6 +160,7 @@ Accept wildcard characters: False ``` ### -Id + Specifies the package identifier. ```yaml @@ -160,6 +176,7 @@ Accept wildcard characters: False ``` ### -InstallerType + Specifies the installer type. ```yaml @@ -176,6 +193,7 @@ Accept wildcard characters: False ``` ### -Locale + Specifies the installer locale. ```yaml @@ -191,6 +209,7 @@ Accept wildcard characters: False ``` ### -Location + Specify the install location. This requires support in the installer. ```yaml @@ -206,6 +225,7 @@ Accept wildcard characters: False ``` ### -Log + Specify the location for the installer log to be written. ```yaml @@ -221,6 +241,7 @@ Accept wildcard characters: False ``` ### -MatchOption + Specify the match type. ```yaml @@ -237,6 +258,7 @@ Accept wildcard characters: False ``` ### -Mode + Specify the installer output mode. Options are "Default", "Silent", and "Interactive". ```yaml @@ -253,6 +275,7 @@ Accept wildcard characters: False ``` ### -Moniker + Specify the package moniker. ```yaml @@ -268,6 +291,7 @@ Accept wildcard characters: False ``` ### -Name + Specify the package name. ```yaml @@ -283,6 +307,7 @@ Accept wildcard characters: False ``` ### -Override + Specify arguments to pass to the installer. This will override arguments in the manifest. ```yaml @@ -298,6 +323,7 @@ Accept wildcard characters: False ``` ### -PSCatalogPackage + WinGet package object. ```yaml @@ -313,6 +339,7 @@ Accept wildcard characters: False ``` ### -Query + Search string. Wildcards are not supported. ```yaml @@ -328,6 +355,7 @@ Accept wildcard characters: False ``` ### -Scope + Specify installer scope. Valid values are "Any", "User", "System", "UserOrUnknown", "SystemOrUnknown". ```yaml @@ -344,6 +372,7 @@ Accept wildcard characters: False ``` ### -SkipDependencies + Skip dependency installation. ```yaml @@ -359,6 +388,7 @@ Accept wildcard characters: False ``` ### -Source + Specify configured WinGet source. ```yaml @@ -374,6 +404,7 @@ Accept wildcard characters: False ``` ### -Version + Specify package version. ```yaml @@ -389,6 +420,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -404,6 +436,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -420,7 +453,11 @@ 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). + +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index 30f9726771..a3fb030a8e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -21,7 +21,7 @@ Verifies WinGet is installed properly. Disables an administrative setting. ### [Enable-WinGetSetting](Enable-WinGetSetting.md) -Enables an administrative setting. +Enables WinGet administrative settings. ### [Export-WinGetPackage](Export-WinGetPackage.md) Downloads a package. diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md index 974342073e..6133bc6efc 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md @@ -17,22 +17,26 @@ Remove-WinGetSource -Name [] ``` ## DESCRIPTION + Removes a configured source. ## EXAMPLES ### Example 1: Remove a single source by name + ```powershell -PS C:\> Remove-WinGetSource -Name msstore +Remove-WinGetSource -Name msstore ``` Removes the "msstore" WinGet source. -> **Note, you can run Reset-WinGetSource to re-add the default sources back to WinGet.** +> [!NOTE] +> You can run Reset-WinGetSource to re-add the default sources back to WinGet. ## PARAMETERS ### -Name + The name of the source. ```yaml @@ -48,7 +52,11 @@ 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). + +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 @@ -57,6 +65,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md index 4f4597a982..2b76ce9434 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md @@ -13,31 +13,37 @@ Repairs the WinGet client. ## SYNTAX ### IntegrityVersionSet (Default) + ``` Repair-WinGetPackageManager [-AllUsers] [-Force] [-Version ] [] ``` ### IntegrityLatestSet + ``` Repair-WinGetPackageManager [-AllUsers] [-Force] [-Latest] [-IncludePreRelease] [] ``` ## DESCRIPTION -Repairs the WinGet client by installing or updating the client to either the latest or a specified version. This cmdlet also checks to make sure that the client is in a working state. + +Repairs the WinGet client by installing or updating the client to either the latest or a specified +version. This cmdlet also checks to make sure that the client is in a working state. ## EXAMPLES ### Example 1: Repair the WinGet client. + ```powershell -PS C:\> Repair-WinGetPackageManager +Repair-WinGetPackageManager ``` Ensures the current installed version of WinGet is functional. ### Example 2: Force install the latest version. + ```powershell -PS C:\> Repair-WinGetPackageManager -Latest -Force +Repair-WinGetPackageManager -Latest -Force ``` Installs the latest version of WinGet and ensures it functions properly. @@ -45,7 +51,9 @@ Installs the latest version of WinGet and ensures it functions properly. ## PARAMETERS ### -AllUsers -Indicates that this cmdlet repairs the WinGet client for all user accounts on the computer. To use this parameter, you must run the command with administrator permissions. + +Indicates that this cmdlet repairs the WinGet client for all user accounts on the computer. To use +this parameter, you must run the command with administrator permissions. ```yaml Type: System.Management.Automation.SwitchParameter @@ -60,6 +68,7 @@ Accept wildcard characters: False ``` ### -Force + Force the repair even when other checks WinGet would perform would prevent this action. ```yaml @@ -75,6 +84,7 @@ Accept wildcard characters: False ``` ### -IncludePreRelease + Includes prerelease versions of the WinGet client. ```yaml @@ -90,6 +100,7 @@ Accept wildcard characters: False ``` ### -Latest + Installs the latest available version of the WinGet client. ```yaml @@ -105,6 +116,7 @@ Accept wildcard characters: False ``` ### -Version + Specify the WinGet client version. ```yaml @@ -120,7 +132,11 @@ 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). + +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 @@ -135,3 +151,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## 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 index e2d1c24688..4fa413a6f5 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md @@ -17,13 +17,16 @@ Reset-WinGetSource -Name [] ``` ## DESCRIPTION -Resets the current WinGet sources to the default source configurations. This command must be executed with administrator permissions. + +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. +### Example 1: Reset the msstore source + ```powershell -PS C:\> Reset-WinGetSource -Name msstore +Reset-WinGetSource -Name msstore ``` This example resets the configured source named 'msstore' by removing it. @@ -31,6 +34,7 @@ This example resets the configured source named 'msstore' by removing it. ## PARAMETERS ### -Name + The name of the source. ```yaml @@ -46,7 +50,11 @@ 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). + +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 @@ -55,6 +63,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md index f24e668522..9d587bb870 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md @@ -17,19 +17,23 @@ Set-WinGetUserSettings -UserSettings [-Merge] [] ``` ## DESCRIPTION + Sets the behavior of various WinGet settings. For more information about WinGet settings, visit https://aka.ms/winget-settings. ## EXAMPLES ### Example 1: Set progress bar theme. + ```powershell -PS C:\> Set-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } +Set-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } ``` + Sets the theme of the progress bar to rainbow. ### Example 2: Merge install behavior settings. + ```powershell -PS C:\> Set-WinGetUserSettings -UserSettings @{ installBehavior= @{ preferences= @{ scope = "user"}} } -Merge +Set-WinGetUserSettings -UserSettings @{ installBehavior= @{ preferences= @{ scope = "user"}} } -Merge ``` Appends the user scope preference setting to the existing WinGet settings configuration. @@ -37,6 +41,7 @@ Appends the user scope preference setting to the existing WinGet settings config ## PARAMETERS ### -Merge + Appends the provided UserSettings input to the existing settings configuration. ```yaml @@ -52,6 +57,7 @@ Accept wildcard characters: False ``` ### -UserSettings + A hashtable containing the key value pairs representing the WinGet settings. ```yaml @@ -67,7 +73,11 @@ 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). + +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md index 292fb8e749..0949e65fa3 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md @@ -17,20 +17,23 @@ Test-WinGetUserSettings -UserSettings [-IgnoreNotSet] [ Test-WinGetUserSettings -UserSettings @{ installBehavior= @{ preferences= @{ scope = "user"}} } +Test-WinGetUserSettings -UserSettings @{ installBehavior= @{ preferences= @{ scope = "user"}} } ``` Tests if the provided input matches the current WinGet settings configuration. This command will return False if it is not an exact match.. -### Example 2: Test only progress bar setting. +### Example 2: Test only progress bar setting + ```powershell -PS C:\> Test-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } -IgnoreNotSet +Test-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } -IgnoreNotSet ``` Tests if the progress bar theme is set to rainbow. Including the -IgnoreNotSet argument does not include other WinGet settings in the comparison. @@ -38,6 +41,7 @@ Tests if the progress bar theme is set to rainbow. Including the -IgnoreNotSet a ## PARAMETERS ### -IgnoreNotSet + Ignore settings that are not specified in the input. ```yaml @@ -53,6 +57,7 @@ Accept wildcard characters: False ``` ### -UserSettings + A hashtable containing the key value pairs representing the WinGet settings. ```yaml @@ -68,7 +73,11 @@ 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). + +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md index fc4aa70e97..5187d7070e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -37,25 +37,29 @@ Uninstalls the selected package found by searching the installed packages list. ### Example 1: Uninstall a package using a query ```powershell -PS C:\> Uninstall-WinGetPackage Microsoft.PowerShell +Uninstall-WinGetPackage Microsoft.PowerShell ``` -This sample uninstalls the Microsoft.PowerShell package. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring the user to pass "-Id". +This sample uninstalls the Microsoft.PowerShell package. No specific property to identify the query +string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring +the user to pass "-Id". ### Example 2: Uninstall a package by Id ```powershell -PS C:\> Uninstall-WinGetPackage -Id Microsoft.PowerShell +Uninstall-WinGetPackage -Id Microsoft.PowerShell ``` This sample uninstalls the Microsoft.PowerShell package by the specifying the package identifier. -> **If more than one source is configured with the same package identifier, the user must disambiguate** +> [!TIP] +> If more than one source is configured with the same package identifier, the user must +> disambiguate. Use the `Source` parameter to specify the WinGet source. ### Example 3: Uninstall a package by Name ```powershell -PS C:\> Uninstall-WinGetPackage -Name "PowerToys (Preview)" +Uninstall-WinGetPackage -Name "PowerToys (Preview)" ``` This sample uninstalls the PowerToys package by the specifying the package name. @@ -63,10 +67,11 @@ This sample uninstalls the PowerToys package by the specifying the package name. ### Example 4: Uninstall a specific version of a package ```powershell -PS C:\> Uninstall-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 +Uninstall-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 ``` -This sample uninstalls the Microsoft.PowerShell package version 7.4.4.0. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. +This sample uninstalls the Microsoft.PowerShell package version 7.4.4.0. No specific property to +identify the query string "Microsoft.PowerShell" as a package identifier. ## PARAMETERS @@ -139,7 +144,7 @@ Accept wildcard characters: False ### -Mode -Specify the installer output mode. Options are "Default", "Silent", and "Interactive". +Specify the installer output mode. > **Note: Not all uninstallers support all modes.** @@ -288,7 +293,10 @@ 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). +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md index 5f8da6e463..857649c4c0 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -13,6 +13,7 @@ Update a WinGet package. ## SYNTAX ### FoundSet (Default) + ``` Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ] [-Custom ] [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] @@ -23,6 +24,7 @@ Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ``` ### GivenSet + ``` Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ] [-Custom ] [-Location ] [-Log ] [-Force] [-Header ] [-AllowHashMismatch] @@ -32,20 +34,25 @@ Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ``` ## DESCRIPTION + Updates the selected package found by searching the installed packages list. ## EXAMPLES ### Example 1: Update a package using a query + ```powershell -PS C:\> Update-WinGetPackage Microsoft.PowerShell +Update-WinGetPackage Microsoft.PowerShell ``` -This sample updates the Microsoft.PowerShell package. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring the user to pass "-Id". +This sample updates the Microsoft.PowerShell package. No specific property to identify the query +string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring +the user to pass "-Id". ### Example 2: Update a package by Id + ```powershell -PS C:\> Update-WinGetPackage -Id Microsoft.PowerShell +Update-WinGetPackage -Id Microsoft.PowerShell ``` This sample updates the Microsoft.PowerShell package by the specifying the package identifier. @@ -53,22 +60,26 @@ This sample updates the Microsoft.PowerShell package by the specifying the packa > **If more than one source is configured with the same package identifier, the user must disambiguate** ### Example 3: Update a package by Name + ```powershell -PS C:\> Update-WinGetPackage -Name "PowerToys (Preview)" +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 -PS C:\> Update-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 +Update-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 ``` -This sample updates the Microsoft.PowerShell package to version 7.4.4.0. No specific property to identify the query string "Microsoft.PowerShell" as a package identifier. +This sample updates the Microsoft.PowerShell package to version 7.4.4.0. No specific property to +identify the query string "Microsoft.PowerShell" as a package identifier. ## PARAMETERS ### -AllowHashMismatch + Update the package even if the installer download SHA256 doesn't match the manifest. ```yaml @@ -84,6 +95,7 @@ Accept wildcard characters: False ``` ### -Architecture + Specify the installer architecture. ```yaml @@ -100,6 +112,7 @@ Accept wildcard characters: False ``` ### -Custom + Add additional arguments to the installer command. ```yaml @@ -115,6 +128,7 @@ Accept wildcard characters: False ``` ### -Force + Force the update to run the installer. ```yaml @@ -130,6 +144,7 @@ Accept wildcard characters: False ``` ### -Header + Specify a custom value in the HTTP header to the REST source. ```yaml @@ -145,6 +160,7 @@ Accept wildcard characters: False ``` ### -Id + Specify the package identifier. ```yaml @@ -160,6 +176,7 @@ Accept wildcard characters: False ``` ### -IncludeUnknown + Attempt to upgrade the package when the installed version is not specified in the registry. ```yaml @@ -175,6 +192,7 @@ Accept wildcard characters: False ``` ### -InstallerType + Specify the installer type to use. ```yaml @@ -191,6 +209,7 @@ Accept wildcard characters: False ``` ### -Locale + Specify the installer locale. ```yaml @@ -206,6 +225,7 @@ Accept wildcard characters: False ``` ### -Location + Specify the location to install the package. > **Note: Not all installers support this property.** @@ -223,6 +243,7 @@ Accept wildcard characters: False ``` ### -Log + Specify the location for the installer log. > **Note: Not all installers support this property.** @@ -240,6 +261,7 @@ Accept wildcard characters: False ``` ### -MatchOption + Specify the match type to use. ```yaml @@ -256,6 +278,7 @@ Accept wildcard characters: False ``` ### -Mode + Specify the installer output mode. Options are "Default", "Silent", and "Interactive". ```yaml @@ -272,6 +295,7 @@ Accept wildcard characters: False ``` ### -Moniker + Specify the moniker. ```yaml @@ -287,6 +311,7 @@ Accept wildcard characters: False ``` ### -Name + Specify the name. ```yaml @@ -302,6 +327,7 @@ Accept wildcard characters: False ``` ### -Override + Override the switches to pass to the installer. ```yaml @@ -317,6 +343,7 @@ Accept wildcard characters: False ``` ### -PSCatalogPackage + WinGet package object ```yaml @@ -332,6 +359,7 @@ Accept wildcard characters: False ``` ### -Query + Search string. Wildcards are not supported. ```yaml @@ -347,6 +375,7 @@ Accept wildcard characters: False ``` ### -Scope + Specify installer scope. Valid values are "Any", "User", "System", "UserOrUnknown", "SystemOrUnknown". ```yaml @@ -363,6 +392,7 @@ Accept wildcard characters: False ``` ### -SkipDependencies + Skip dependency installation. ```yaml @@ -378,6 +408,7 @@ Accept wildcard characters: False ``` ### -Source + Specify configured WinGet source. ```yaml @@ -393,6 +424,7 @@ Accept wildcard characters: False ``` ### -Version + Specify package version. ```yaml @@ -408,6 +440,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -423,6 +456,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -439,7 +473,11 @@ 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). + +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 From b87076ff2501ebf60d94c4ab205f5b54d6655ee7 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 1 Aug 2024 13:54:01 -0700 Subject: [PATCH 42/55] Add ms.date --- .../Help/Microsoft.WinGet.Client/Add-WinGetSource.md | 1 + .../Assert-WinGetPackageManager.md | 1 + .../Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md | 1 + .../Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md | 1 + .../Help/Microsoft.WinGet.Client/Export-WinGetPackage.md | 1 + .../Help/Microsoft.WinGet.Client/Find-WinGetPackage.md | 1 + .../Help/Microsoft.WinGet.Client/Get-WinGetPackage.md | 1 + .../Help/Microsoft.WinGet.Client/Get-WinGetSettings.md | 1 + .../Help/Microsoft.WinGet.Client/Get-WinGetSource.md | 1 + .../Microsoft.WinGet.Client/Get-WinGetUserSettings.md | 1 + .../Help/Microsoft.WinGet.Client/Get-WinGetVersion.md | 1 + .../Help/Microsoft.WinGet.Client/Install-WinGetPackage.md | 1 + .../Microsoft.WinGet.Client/Microsoft.WinGet.Client.md | 1 + .../Help/Microsoft.WinGet.Client/Remove-WinGetSource.md | 1 + .../Repair-WinGetPackageManager.md | 5 +++-- .../Help/Microsoft.WinGet.Client/Reset-WinGetSource.md | 1 + .../Microsoft.WinGet.Client/Set-WinGetUserSettings.md | 8 +++++--- .../Microsoft.WinGet.Client/Test-WinGetUserSettings.md | 1 + .../Microsoft.WinGet.Client/Uninstall-WinGetPackage.md | 1 + .../Help/Microsoft.WinGet.Client/Update-WinGetPackage.md | 1 + 20 files changed, 26 insertions(+), 5 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index c68d1592d8..f08326d923 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md index 235a5850e8..d0a1823648 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md index b40c05c950..e786d4b550 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md index fc31d7a55f..365ffb7992 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index 512a4c404a..574aa6e504 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md index 9230c16529..c295d3435d 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md index 8f76dd4eae..bfb81ef984 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md index ff765add69..ca6724bbb0 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md index 6ecc9e2575..9fcd81dbb8 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md index bd4577bcaf..7f1f0260a6 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md index 21fdf1801f..fecd1c8c73 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 39a6db5a9f..80a8e11dd9 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index a3fb030a8e..ea3315cd6a 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -1,5 +1,6 @@ --- 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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md index 6133bc6efc..791e75a3e1 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md index 2b76ce9434..b07c965cb4 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md @@ -1,6 +1,7 @@ --- 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 --- @@ -32,7 +33,7 @@ version. This cmdlet also checks to make sure that the client is in a working st ## EXAMPLES -### Example 1: Repair the WinGet client. +### Example 1: Repair the WinGet client ```powershell Repair-WinGetPackageManager @@ -40,7 +41,7 @@ Repair-WinGetPackageManager Ensures the current installed version of WinGet is functional. -### Example 2: Force install the latest version. +### Example 2: Force install the latest version ```powershell Repair-WinGetPackageManager -Latest -Force diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md index 4fa413a6f5..692f7daf35 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md index 9d587bb870..2df0e6f1f1 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md @@ -1,6 +1,7 @@ --- 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 --- @@ -18,11 +19,12 @@ Set-WinGetUserSettings -UserSettings [-Merge] [] ## DESCRIPTION -Sets the behavior of various WinGet settings. For more information about WinGet settings, visit https://aka.ms/winget-settings. +Sets the behavior of various WinGet settings. For more information about WinGet settings, see +[WinGet CLI Settings](https://aka.ms/winget-settings). ## EXAMPLES -### Example 1: Set progress bar theme. +### Example 1: Set progress bar theme ```powershell Set-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } @@ -30,7 +32,7 @@ Set-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } Sets the theme of the progress bar to rainbow. -### Example 2: Merge install behavior settings. +### Example 2: Merge install behavior settings ```powershell Set-WinGetUserSettings -UserSettings @{ installBehavior= @{ preferences= @{ scope = "user"}} } -Merge diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md index 0949e65fa3..12521ea02e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md index 5187d7070e..2351ff72c4 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -1,6 +1,7 @@ --- 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 --- diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md index 857649c4c0..3edd10c5e1 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -1,6 +1,7 @@ --- 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 --- From 1d3797dbf6d11021eaa70428870a026f5344fa3e Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 1 Aug 2024 13:55:23 -0700 Subject: [PATCH 43/55] fix typo --- .../Help/Microsoft.WinGet.Client/Export-WinGetPackage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index 574aa6e504..3836d43aeb 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -267,7 +267,7 @@ Accept wildcard characters: False ### -SkipDependencies -Specifes the WinGet package dependencies should not be downloaded. +Specifies the WinGet package dependencies should not be downloaded. ```yaml Type: System.Management.Automation.SwitchParameter From 7735d76aebf407b8076fa73547ff17aa97c1807c Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 1 Aug 2024 13:57:23 -0700 Subject: [PATCH 44/55] update spelling --- .github/actions/spelling/expect.txt | 8 -------- 1 file changed, 8 deletions(-) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 0c10474461..1d867e311a 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -45,7 +45,6 @@ ASYNCRTIMP Atest ATL AType -atx AUrl auxdata azcopy @@ -62,7 +61,6 @@ bitmask bkup blargle blockedbypolicy -blockquote blogs bluetooth Bomgar @@ -93,7 +91,6 @@ CMSG cobertura CODEOWNERS codepage -codesnippet COINIT COMGLB commandline @@ -133,7 +130,6 @@ diskfull displaycatalog DMC dnld -docsmd Dobbeleer DONOT dsc @@ -252,7 +248,6 @@ jsoncpp JToken JValue Kaido -kbd KNOWNFOLDERID kool ktf @@ -295,7 +290,6 @@ maclachlan MAJORVERSION malware mapdatafolding -markdownlint Maxed MAXLENGTH maxvalue @@ -478,14 +472,12 @@ schematab Scm sddl SECUREFILEPATH -securelinks secureobject securestring seof servercert servercertificate setmetadatabymanifestid -settext SETTINGCHANGE SETTINGMAPPING sfs From 52bbc0bf848f844aef44278bc1704f0794091037 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 1 Aug 2024 14:01:15 -0700 Subject: [PATCH 45/55] Add title front matter --- src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md | 1 + .../Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md | 1 + .../Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md | 1 + .../Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md | 1 + .../Help/Microsoft.WinGet.Client/Export-WinGetPackage.md | 1 + .../Help/Microsoft.WinGet.Client/Find-WinGetPackage.md | 1 + src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md | 1 + .../Help/Microsoft.WinGet.Client/Get-WinGetSettings.md | 1 + src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md | 1 + .../Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md | 1 + src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md | 1 + .../Help/Microsoft.WinGet.Client/Install-WinGetPackage.md | 1 + .../Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md | 1 + .../Help/Microsoft.WinGet.Client/Remove-WinGetSource.md | 1 + .../Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md | 1 + .../Help/Microsoft.WinGet.Client/Reset-WinGetSource.md | 1 + .../Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md | 1 + .../Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md | 1 + .../Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md | 1 + .../Help/Microsoft.WinGet.Client/Update-WinGetPackage.md | 1 + 20 files changed, 20 insertions(+) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index f08326d923..bf289e25da 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Add-WinGetSource --- # Add-WinGetSource diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md index d0a1823648..48dedf9fbc 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Assert-WinGetPackageManager --- # Assert-WinGetPackageManager diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md index e786d4b550..f036621e19 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Disable-WinGetSetting --- # Disable-WinGetSetting diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md index 365ffb7992..9f38448188 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Enable-WinGetSetting --- # Enable-WinGetSetting diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index 3836d43aeb..59e45dcf50 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Export-WinGetPackage --- # Export-WinGetPackage diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md index c295d3435d..1a9913ff39 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Find-WinGetPackage --- # Find-WinGetPackage diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md index bfb81ef984..185f43f9e6 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Get-WinGetPackage --- # Get-WinGetPackage diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md index ca6724bbb0..63e3490270 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Get-WinGetSettings --- # Get-WinGetSettings diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md index 9fcd81dbb8..381cb042ad 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Get-WinGetSource --- # Get-WinGetSource diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md index 7f1f0260a6..58f6102157 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Get-WinGetUserSettings --- # Get-WinGetUserSettings diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md index fecd1c8c73..b7da501b9d 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Get-WinGetVersion --- # Get-WinGetVersion diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 80a8e11dd9..9a25374ffd 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Install-WinGetPackage --- # Install-WinGetPackage diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md index ea3315cd6a..44689febb5 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Microsoft.WinGet.Client.md @@ -5,6 +5,7 @@ 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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md index 791e75a3e1..1968686ba3 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Remove-WinGetSource --- # Remove-WinGetSource diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md index b07c965cb4..b6d88d7171 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Repair-WinGetPackageManager --- # Repair-WinGetPackageManager diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md index 692f7daf35..629cbd3bac 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Reset-WinGetSource.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Reset-WinGetSource --- # Reset-WinGetSource diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md index 2df0e6f1f1..a02cef4980 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Set-WinGetUserSettings --- # Set-WinGetUserSettings diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md index 12521ea02e..8401623795 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Test-WinGetUserSettings --- # Test-WinGetUserSettings diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md index 2351ff72c4..c590c9f01e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Uninstall-WinGetPackage --- # Uninstall-WinGetPackage diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md index 3edd10c5e1..89dcaa4df3 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -4,6 +4,7 @@ Module Name: Microsoft.WinGet.Client ms.date: 08/01/2024 online version: schema: 2.0.0 +title: Update-WinGetPackage --- # Update-WinGetPackage From 919db64b9b9eccd34ea755f199f374287611d448 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Wed, 7 Aug 2024 15:26:58 -0700 Subject: [PATCH 46/55] Update src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md Co-authored-by: Sean Wheeler --- .../Help/Microsoft.WinGet.Client/Add-WinGetSource.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index bf289e25da..2882cc9cfb 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -70,8 +70,8 @@ Accept wildcard characters: False ### -Type -The type of the WinGet source. Most sources will be `Microsoft.Rest`. The WinGet community -repository is `Microsoft.PreIndexed.Package`. +The type of the WinGet source. Most sources are `Microsoft.Rest`. The WinGet community repository +is `Microsoft.PreIndexed.Package`. ```yaml Type: System.String From acdc322afae221ecf393485ea6978aa91932e2c1 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Wed, 7 Aug 2024 15:27:12 -0700 Subject: [PATCH 47/55] Update src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md Co-authored-by: Sean Wheeler --- .../Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md index 48dedf9fbc..6237555bee 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md @@ -28,7 +28,7 @@ Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [] ## DESCRIPTION -Verifies WinGet is installed properly. +Verifies that WinGet is installed properly. > [!NOTE] > This does not ensure the latest version of WinGet is installed. This just verifies the current From 3d92c9477fcac72b8ef389e88b97bdf53e45ba7a Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Wed, 7 Aug 2024 15:27:27 -0700 Subject: [PATCH 48/55] Update src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md Co-authored-by: Sean Wheeler --- .../Microsoft.WinGet.Client/Export-WinGetPackage.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index 59e45dcf50..013d06c4f5 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -230,9 +230,13 @@ Accept wildcard characters: False ### -Query -Search string for WinGet package. The query parameter will be used to search across multiple -properties in a WinGet package manifest. Fields include the package name, package identifier, -moniker, and tags. +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[] From 180b9881c38a1bb74e98b85aa8992b603564e8eb Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Wed, 7 Aug 2024 15:32:34 -0700 Subject: [PATCH 49/55] Apply suggestions from code review Co-authored-by: Sean Wheeler --- .../Assert-WinGetPackageManager.md | 30 +++---- .../Disable-WinGetSetting.md | 26 +++--- .../Enable-WinGetSetting.md | 26 +++--- .../Export-WinGetPackage.md | 90 ++++++++++++++----- 4 files changed, 109 insertions(+), 63 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md index 6237555bee..727ecf6358 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md @@ -10,7 +10,7 @@ title: Assert-WinGetPackageManager # Assert-WinGetPackageManager ## SYNOPSIS -Verifies WinGet is installed properly. +Verifies that WinGet is installed properly. ## SYNTAX @@ -31,8 +31,9 @@ Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [] Verifies that WinGet is installed properly. > [!NOTE] -> This does not ensure the latest version of WinGet is installed. This just verifies the current -> installed version correlated with the Microsoft.WinGet.Client module is functional. +> 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 @@ -42,8 +43,7 @@ Verifies that WinGet is installed properly. Assert-WinGetPackageManager ``` -If the current version of WinGet is installed correctly this will return without error. This does -not upgrade WinGet to the latest version. +If the current version of WinGet is installed correctly, the command returns without error. ### Example 2: Check if latest stable version is installed @@ -51,8 +51,8 @@ not upgrade WinGet to the latest version. Assert-WinGetPackageManager -Latest ``` -If the latest version of WinGet correlated with the Microsoft.WinGet.Client module is installed -correctly this will return without error. +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 @@ -60,8 +60,8 @@ correctly this will return without error. Assert-WinGetPackageManager -IncludePreRelease ``` -If a preview version of WinGet correlated with the Microsoft.WinGet.Client module is installed -correctly this will return without error. +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 @@ -69,14 +69,14 @@ correctly this will return without error. Assert-WinGetPackageManager -Version v1.8.1911 ``` -If the specified version of WinGet correlated with the Microsoft.WinGet.Client module is installed -correctly this will return without error. +If the specified version of WinGet is compatible with the installed Microsoft.WinGet.Client module, +the command returns without error. ## PARAMETERS ### -IncludePreRelease -Includes preview versions of WinGet. +Include preview versions of WinGet. ```yaml Type: System.Management.Automation.SwitchParameter @@ -92,8 +92,8 @@ Accept wildcard characters: False ### -Latest -Verifies the latest version of WinGet correlated with the Microsoft.WinGet.Client module is -installed. +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 @@ -109,7 +109,7 @@ Accept wildcard characters: False ### -Version -Verifies a specific version of WinGet is installed. +Verify that a specific version of WinGet is installed correctly. ```yaml Type: System.String diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md index f036621e19..d363183c25 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Disable-WinGetSetting.md @@ -20,18 +20,20 @@ Disable-WinGetSetting [-Name] [] ## DESCRIPTION -Disables an administrative setting. Requires administrator access. +This command disables an administrative setting. The command must be run from an elevated session +using the **Run as Administrator** option. -Administrator Settings default to "Disabled" and may be controlled by Group Policy Objects. +This command support the following administrative settings: -Administrator Settings: +- LocalManifestFiles +- BypassCertificatePinningForMicrosoftStore +- InstallerHashOverride +- LocalArchiveMalwareScanOverride +- ProxyCommandLineOptions +- DefaultProxy -* LocalManifestFiles -* BypassCertificatePinningForMicrosoftStore -* InstallerHashOverride -* LocalArchiveMalwareScanOverride -* ProxyCommandLineOptions -* DefaultProxy +Administrative settings are disabled by default. Administrative settings can also be managed using +Group Policy objects. ## EXAMPLES @@ -41,13 +43,13 @@ Administrator Settings: Disable-WinGetSetting -Name LocalManifestFiles ``` -Disables the use of local manifest files. +This example shows how to disable the use of local manifest files. ## PARAMETERS ### -Name -The name of the WinGet administrator setting +The name of the WinGet administrative setting. ```yaml Type: System.String @@ -82,4 +84,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-WinGetSettings](Get-WinGetSettings.md) -[Set-WinGetSetting](Set-WinGetSetting.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 index 9f38448188..6c9c6d6efb 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Enable-WinGetSetting.md @@ -21,18 +21,20 @@ Enable-WinGetSetting [-Name] [] ## DESCRIPTION -Enables an administrative setting. Requires administrator access. +This command enables an administrative setting. The command must be run from an elevated session +using the **Run as Administrator** option. -Administrator Settings default to "Disabled" and may be controlled by Group Policy Objects. +This command support the following administrative settings: -Administrator Settings: +- LocalManifestFiles +- BypassCertificatePinningForMicrosoftStore +- InstallerHashOverride +- LocalArchiveMalwareScanOverride +- ProxyCommandLineOptions +- DefaultProxy -* LocalManifestFiles -* BypassCertificatePinningForMicrosoftStore -* InstallerHashOverride -* LocalArchiveMalwareScanOverride -* ProxyCommandLineOptions -* DefaultProxy +Administrative settings are disabled by default. Administrative settings can also be managed using +Group Policy objects. ## EXAMPLES @@ -42,13 +44,13 @@ Administrator Settings: Enable-WinGetSetting -Name LocalManifestFiles ``` -Enables the use of local manifest files. +This example shows how to enable the use of local manifest files. ## PARAMETERS ### -Name -The name of the WinGet administrator setting +The name of the WinGet administrative setting. ```yaml Type: System.String @@ -83,4 +85,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-WinGetSettings](Get-WinGetSettings.md) -[Disable-WinGetSetting](Disable-WinGetSetting) +[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 index 013d06c4f5..69f4b79ecc 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -10,7 +10,7 @@ title: Export-WinGetPackage # Export-WinGetPackage ## SYNOPSIS -Downloads a package. +Downloads a WinGet package and its dependencies. ## SYNTAX @@ -35,14 +35,17 @@ Export-WinGetPackage [-DownloadDirectory ] [-AllowHashMismatch] ## DESCRIPTION -Downloads a package installer from the pipeline or from a configured source. The package manifest as -well as dependencies and their manifests will be included. The default directory if not specified is -the Downloads folder. +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 the your `Downloads` folder. You can use the **DownloadDirectory** parameter to change +the location. -If the package is coming from the Microsoft Store, the user initiating the Offline License retrieval -needs to be a member of one of the following Roles in Azure: Global Administrator, User -Administrator, or License Administrator. If the user is a member of any of those groups, they will -receive a copy of the license file. +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 @@ -52,16 +55,36 @@ receive a copy of the license file. Export-WinGetPackage -Id Microsoft.PowerShell ``` -This example will download the latest available version of the Microsoft.PowerShell installer (for -the current system and default scope) and the manifest to a folder (named by concatenating the -package identifier with an underscore and the version number) in the Downloads directory. +```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 -Allow the download even if the SHA256 hash for an installer or a dependency does not match the -SHA256 hash in the WinGet package manifest. +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 @@ -77,7 +100,7 @@ Accept wildcard characters: False ### -Architecture -Specify the architecture for the WinGet package installer +Specify the processor architecture for the WinGet package installer. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture @@ -94,7 +117,7 @@ Accept wildcard characters: False ### -DownloadDirectory -Specify the directory for the download +Specify the location where you want to store the downloaded files. ```yaml Type: System.String @@ -126,7 +149,19 @@ Accept wildcard characters: False ### -InstallerType -Specify the installer type for the WinGet package installer +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. @@ -146,7 +181,9 @@ Accept wildcard characters: False ### -Locale -Specify the installer locale for the WinGet package installer 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. @@ -165,7 +202,12 @@ Accept wildcard characters: False ### -MatchOption -Specify the match option for a WinGet package query +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 @@ -182,7 +224,8 @@ Accept wildcard characters: False ### -Moniker -Specify the WinGet package 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 @@ -198,7 +241,7 @@ Accept wildcard characters: False ### -Name -Specify the WinGet package name +Specify the name of the WinGet package. ```yaml Type: System.String @@ -272,7 +315,7 @@ Accept wildcard characters: False ### -SkipDependencies -Specifies the WinGet package dependencies should not be downloaded. +Specifies that the command shouldn't download the WinGet package dependencies. ```yaml Type: System.Management.Automation.SwitchParameter @@ -304,7 +347,7 @@ Accept wildcard characters: False ### -Version -Specifies the WinGet package version to download +Specifies the version of the WinGet package to download. ```yaml Type: System.String @@ -336,8 +379,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter From 0e6d287b7949f0d8717f3051ed4bfd8d802c99f1 Mon Sep 17 00:00:00 2001 From: Demitrius Nelon Date: Thu, 8 Aug 2024 11:45:58 -0700 Subject: [PATCH 50/55] Apply suggestions from code review Co-authored-by: Sean Wheeler --- .../Find-WinGetPackage.md | 55 +++++++++++++------ .../Get-WinGetPackage.md | 42 +++++++++----- 2 files changed, 67 insertions(+), 30 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md index 1a9913ff39..853822fa3a 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -10,7 +10,7 @@ title: Find-WinGetPackage # Find-WinGetPackage ## SYNOPSIS -Searches configured sources for packages. +Searches for packages from configured sources. ## SYNTAX @@ -22,7 +22,7 @@ Find-WinGetPackage [-Tag ] [-Command ] [-Count ] [-Id ] [-Command ] [-Count ] [-Id **Packages with leading "ARP" or "MSIX" are installed on the device, but not correlated with any configured source. +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 @@ -34,13 +34,14 @@ Lists installed packages. Get-WinGetPackage ``` -Lists installed packages. +This example shows how to list all packages installed on your system. ## PARAMETERS ### -Command -Filter results by their command +Specify the name of the command contained in the package. The command filters the results to +packages that match this value. ```yaml Type: System.String @@ -56,7 +57,7 @@ Accept wildcard characters: False ### -Count -Limit the number of results +Limits the number of items returned by the command. ```yaml Type: System.UInt32 @@ -72,7 +73,8 @@ Accept wildcard characters: False ### -Id -Filter results by their package identifier +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 @@ -88,7 +90,12 @@ Accept wildcard characters: False ### -MatchOption -Specify the matching logic +Specify matching logic used for search. The parameter accepts the following values: + +- `Equals` +- `EqualsCaseInsensitive` +- `StartsWithCaseInsensitive` +- `ContainsCaseInsensitive` ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageFieldMatchOption @@ -105,7 +112,7 @@ Accept wildcard characters: False ### -Moniker -Filter results by package moniker +Specify the moniker of the package you want to list. ```yaml Type: System.String @@ -121,7 +128,8 @@ Accept wildcard characters: False ### -Name -Filter results by package 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 @@ -137,7 +145,15 @@ Accept wildcard characters: False ### -Query -Specifies query string to search for +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[] @@ -153,7 +169,7 @@ Accept wildcard characters: False ### -Source -Specify the source +Specify the name of the WinGet source of the package. ```yaml Type: System.String @@ -169,7 +185,7 @@ Accept wildcard characters: False ### -Tag -Filter by Tag +Specify a package tag to search for. ```yaml Type: System.String From e5f637ccbfa36b8ed1c290cf965ccfb19533d8db Mon Sep 17 00:00:00 2001 From: ryfu-msft Date: Fri, 9 Aug 2024 11:28:29 -0700 Subject: [PATCH 51/55] resolve suggestions --- .../Export-WinGetPackage.md | 8 +- .../Get-WinGetSettings.md | 38 +++++- .../Get-WinGetSource.md | 13 +- .../Get-WinGetUserSettings.md | 8 +- .../Get-WinGetVersion.md | 2 +- .../Install-WinGetPackage.md | 108 +++++++++++---- .../Remove-WinGetSource.md | 10 +- .../Repair-WinGetPackageManager.md | 26 ++-- .../Set-WinGetUserSettings.md | 35 ++++- .../Test-WinGetUserSettings.md | 28 +++- .../Uninstall-WinGetPackage.md | 69 ++++++---- .../Update-WinGetPackage.md | 129 +++++++++++++----- 12 files changed, 346 insertions(+), 128 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index 69f4b79ecc..ff09b8468d 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -295,7 +295,13 @@ Accept wildcard characters: False ### -Scope -Specify WinGet package installer 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. diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md index 63e3490270..e73c0d2adf 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -10,7 +10,7 @@ title: Get-WinGetSettings # Get-WinGetSettings ## SYNOPSIS -Gets WinGet settings. +Gets WinGet configuration settings. ## SYNTAX @@ -20,19 +20,45 @@ Get-WinGetSettings [-AsPlainText] [] ## DESCRIPTION -Get WinGet settings. This includes the user settings file, administrator settings, and the settings -schema. For more information about WinGet settings, visit `https://aka.ms/winget-settings`. +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 +### Example 1 - Display the WinGet configuration settings ```powershell Get-WinGetSettings ``` -This will display the user settings file location, the administrator settings, and the settings -schema URL. +```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 +---- ----- +ProxyCommandLineOptions False +LocalArchiveMalwareScanOverri… False +InstallerHashOverride False +BypassCertificatePinningForMi… False +LocalManifestFiles False +``` ## PARAMETERS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md index 381cb042ad..d0cb84a459 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSource.md @@ -20,23 +20,28 @@ Get-WinGetSource [[-Name] ] [] ## DESCRIPTION -List configured WinGet sources. +Lists the configured WinGet sources. ## EXAMPLES -### Example 1: Default example +### Example 1: List all configured WinGet sources ```powershell Get-WinGetSource ``` -This will list the configured WinGet sources. The two default sources are "msstore" and "winget". +```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 -Filter by WinGet source name +Specify the name of the WinGet source to be displayed. ```yaml Type: System.String diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md index 58f6102157..8018b621a3 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md @@ -20,18 +20,18 @@ Get-WinGetUserSettings [] ## DESCRIPTION -Get user settings for WinGet. +This command displays the WinGet settings for the current user. The settings are stored in +`$env:LOCALAPPDATA\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\LocalState\settings.json`. +This file only exists if you have change a user setting using the `Set-WinGetUserSettings` command. ## EXAMPLES -### Example 1: Default +### Example 1: Get the WinGet settings for the current user ```powershell Get-WinGetUserSettings ``` -Gets the WinGet user settings from the user's settings.json file. - ## PARAMETERS ### CommonParameters diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md index b7da501b9d..dd216df198 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetVersion.md @@ -20,7 +20,7 @@ Get-WinGetVersion [] ## DESCRIPTION -Get the installed version of WinGet. +Gets the installed version of WinGet. ## EXAMPLES diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 9a25374ffd..18e4beea5b 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -37,7 +37,10 @@ Install-WinGetPackage [-Mode ] [-Override ] [-Cust ## DESCRIPTION -Installs a WinGet package from a configured source. +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. +Wildards are not supported. You can change the search behavior using the **MatchOption** parameter. ## EXAMPLES @@ -47,9 +50,8 @@ Installs a WinGet package from a configured source. Install-WinGetPackage Microsoft.PowerShell ``` -This sample installs the Microsoft.PowerShell package. No specific property to identify the query -string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring -the user to pass "-Id". +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 @@ -57,7 +59,9 @@ the user to pass "-Id". Install-WinGetPackage -Id Microsoft.PowerShell ``` -This sample installs the Microsoft.PowerShell package by the specifying the package identifier. +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** @@ -67,7 +71,7 @@ This sample installs the Microsoft.PowerShell package by the specifying the pack Install-WinGetPackage -Name "PowerToys (Preview)" ``` -This sample installs the PowerToys package by the specifying the package name. +This example shows how to install a package by specifying the package name. ### Example 4: Install a specific version of a package @@ -75,14 +79,16 @@ This sample installs the PowerToys package by the specifying the package name. Install-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 ``` -This sample installs the Microsoft.PowerShell package version 7.4.4.0. No specific property to -identify the query string "Microsoft.PowerShell" as a package identifier. +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 -Allow the install to continue even if the SHA256 has does not match. +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 @@ -98,7 +104,7 @@ Accept wildcard characters: False ### -Architecture -Specify the hardware architecture for the installer. +Specify the processor architecture for the WinGet package installer. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSProcessorArchitecture @@ -115,7 +121,10 @@ Accept wildcard characters: False ### -Custom -Arguments to be passed to the installer in addition to those in the manifest. +Use this paramater 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 @@ -163,7 +172,8 @@ Accept wildcard characters: False ### -Id -Specifies the package identifier. +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 @@ -179,7 +189,19 @@ Accept wildcard characters: False ### -InstallerType -Specifies the installer type. +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 @@ -196,7 +218,9 @@ Accept wildcard characters: False ### -Locale -Specifies the installer 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 @@ -212,7 +236,8 @@ Accept wildcard characters: False ### -Location -Specify the install location. This requires support in the installer. +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 @@ -244,7 +269,11 @@ Accept wildcard characters: False ### -MatchOption -Specify the match type. +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 @@ -261,7 +290,10 @@ Accept wildcard characters: False ### -Mode -Specify the installer output mode. Options are "Default", "Silent", and "Interactive". +Specify the output mode for the installer. The parameter accepts the following values: +- `Default` +- `Silent` +- `Interactive` ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageInstallMode @@ -278,7 +310,8 @@ Accept wildcard characters: False ### -Moniker -Specify the package 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 @@ -294,7 +327,7 @@ Accept wildcard characters: False ### -Name -Specify the package name. +Specify the name of the package to be installed. ```yaml Type: System.String @@ -310,7 +343,10 @@ Accept wildcard characters: False ### -Override -Specify arguments to pass to the installer. This will override arguments in the manifest. +Specify arguments to pass to the installer as a single string. To pass multiple arguments, include +the arguments in the string. The arguments must be provided in the format expected by the installer. +If the string contains spaces, it must be enclosed in quotes. This string overrides the arguments in +the package manifest. ```yaml Type: System.String @@ -326,7 +362,8 @@ Accept wildcard characters: False ### -PSCatalogPackage -WinGet package object. +Provide **PSCatalogPackage** object. You can get a **PSCatalogPackage** object by using the +`Find-WinGetPackage` command. ```yaml Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage @@ -342,7 +379,14 @@ Accept wildcard characters: False ### -Query -Search string. Wildcards are not supported. +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[] @@ -358,7 +402,16 @@ Accept wildcard characters: False ### -Scope -Specify installer scope. Valid values are "Any", "User", "System", "UserOrUnknown", "SystemOrUnknown". +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 @@ -375,7 +428,7 @@ Accept wildcard characters: False ### -SkipDependencies -Skip dependency installation. +Specifies that the command shouldn't install the WinGet package dependencies. ```yaml Type: System.Management.Automation.SwitchParameter @@ -391,7 +444,7 @@ Accept wildcard characters: False ### -Source -Specify configured WinGet source. +Specify the name of the WinGet source from which the package should be installed. ```yaml Type: System.String @@ -407,7 +460,7 @@ Accept wildcard characters: False ### -Version -Specify package version. +Specify the version of the package. ```yaml Type: System.String @@ -439,8 +492,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md index 1968686ba3..40f0064f72 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md @@ -20,7 +20,8 @@ Remove-WinGetSource -Name [] ## DESCRIPTION -Removes a configured source. +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`. ## EXAMPLES @@ -30,16 +31,13 @@ Removes a configured source. Remove-WinGetSource -Name msstore ``` -Removes the "msstore" WinGet source. - -> [!NOTE] -> You can run Reset-WinGetSource to re-add the default sources back to WinGet. +The example shows how to remove a WinGet source by name. ## PARAMETERS ### -Name -The name of the source. +Specify the name of the source to be removed. ```yaml Type: System.String diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md index b6d88d7171..0a06e96ef6 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md @@ -10,7 +10,7 @@ title: Repair-WinGetPackageManager # Repair-WinGetPackageManager ## SYNOPSIS -Repairs the WinGet client. +Repairs the installation of the WinGet client on your computer. ## SYNTAX @@ -29,8 +29,9 @@ Repair-WinGetPackageManager [-AllUsers] [-Force] [-Latest] [-IncludePreRelease] ## DESCRIPTION -Repairs the WinGet client by installing or updating the client to either the latest or a specified -version. This cmdlet also checks to make sure that the client is in a working state. +This command repairs the installation of the WinGet client on your computer by installing the +specified version or the latest version of the client. It ensures that the client is installed in a +working state. ## EXAMPLES @@ -40,7 +41,7 @@ version. This cmdlet also checks to make sure that the client is in a working st Repair-WinGetPackageManager ``` -Ensures the current installed version of WinGet is functional. +Ensures that the current installed version of WinGet is functioning properly. ### Example 2: Force install the latest version @@ -48,14 +49,16 @@ Ensures the current installed version of WinGet is functional. Repair-WinGetPackageManager -Latest -Force ``` -Installs the latest version of WinGet and ensures it functions properly. +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 -Indicates that this cmdlet repairs the WinGet client for all user accounts on the computer. To use -this parameter, you must run the command with administrator permissions. +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 @@ -71,7 +74,8 @@ Accept wildcard characters: False ### -Force -Force the repair even when other checks WinGet would perform would prevent this action. +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 @@ -87,7 +91,7 @@ Accept wildcard characters: False ### -IncludePreRelease -Includes prerelease versions of the WinGet client. +Use this parameter to include prerelease versions of the WinGet client. ```yaml Type: System.Management.Automation.SwitchParameter @@ -103,7 +107,7 @@ Accept wildcard characters: False ### -Latest -Installs the latest available version of the WinGet client. +Use this parameter to install the latest available version of the WinGet client. ```yaml Type: System.Management.Automation.SwitchParameter @@ -119,7 +123,7 @@ Accept wildcard characters: False ### -Version -Specify the WinGet client version. +Use this parameter to specify the specific version of the WinGet client to install. ```yaml Type: System.String diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md index a02cef4980..b76a7c4f4a 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Set-WinGetUserSettings.md @@ -10,7 +10,7 @@ title: Set-WinGetUserSettings # Set-WinGetUserSettings ## SYNOPSIS -Sets WinGet settings. +Sets configuration settings of the WinGet client for the current user. ## SYNTAX @@ -20,7 +20,10 @@ Set-WinGetUserSettings -UserSettings [-Merge] [] ## DESCRIPTION -Sets the behavior of various WinGet settings. For more information about WinGet settings, see +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 @@ -28,7 +31,11 @@ Sets the behavior of various WinGet settings. For more information about WinGet ### Example 1: Set progress bar theme ```powershell -Set-WinGetUserSettings -UserSettings @{ visual= @{ progressBar="rainbow"} } +Set-WinGetUserSettings -UserSettings @{ + visual = @{ + progressBar = 'rainbow' + } +} ``` Sets the theme of the progress bar to rainbow. @@ -36,16 +43,34 @@ Sets the theme of the progress bar to rainbow. ### Example 2: Merge install behavior settings ```powershell -Set-WinGetUserSettings -UserSettings @{ installBehavior= @{ preferences= @{ scope = "user"}} } -Merge +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 -Appends the provided UserSettings input to the existing settings configuration. +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md index 8401623795..fbc0100c95 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Test-WinGetUserSettings.md @@ -10,7 +10,7 @@ title: Test-WinGetUserSettings # Test-WinGetUserSettings ## SYNOPSIS -Tests WinGet settings. +Tests the current state of WinGet user settings. ## SYNTAX @@ -20,31 +20,45 @@ Test-WinGetUserSettings -UserSettings [-IgnoreNotSet] [] [-Force] [-Log ## DESCRIPTION -Uninstalls the selected package found by searching the installed packages list. +This command uninstalls a WinGet package from your computer. The command includes parameters to +specify values used to search for installed packages. By default, all string-based searches are +case-insensitive substring searches. Wildards are not supported. You can change the search behavior +using the **MatchOption** parameter. ## EXAMPLES @@ -42,9 +45,8 @@ Uninstalls the selected package found by searching the installed packages list. Uninstall-WinGetPackage Microsoft.PowerShell ``` -This sample uninstalls the Microsoft.PowerShell package. No specific property to identify the query -string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring -the user to pass "-Id". +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 @@ -52,11 +54,10 @@ the user to pass "-Id". Uninstall-WinGetPackage -Id Microsoft.PowerShell ``` -This sample uninstalls the Microsoft.PowerShell package by the specifying the package identifier. +This example shows how to uninstall a package by the specifying the package identifier. -> [!TIP] -> If more than one source is configured with the same package identifier, the user must -> disambiguate. Use the `Source` parameter to specify the WinGet source. +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 @@ -72,8 +73,9 @@ This sample uninstalls the PowerToys package by the specifying the package name. Uninstall-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 ``` -This sample uninstalls the Microsoft.PowerShell package version 7.4.4.0. No specific property to -identify the query string "Microsoft.PowerShell" as a package identifier. +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 @@ -95,7 +97,8 @@ Accept wildcard characters: False ### -Id -Specify package identifier +Specify the package identifier to search for. By default, the command does a case-insensitive +substring match. ```yaml Type: System.String @@ -129,7 +132,12 @@ Accept wildcard characters: False ### -MatchOption -Specify the match type to use. +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 @@ -146,9 +154,14 @@ Accept wildcard characters: False ### -Mode -Specify the installer output mode. +Specify the output mode for the installer. The parameter accepts the following values: + +- `Default` +- `Silent` +- `Interactive` -> **Note: Not all uninstallers support all modes.** +> [!NOTE] +> Not all uninstallers support all modes. ```yaml Type: Microsoft.WinGet.Client.PSObjects.PSPackageUninstallMode @@ -165,7 +178,8 @@ Accept wildcard characters: False ### -Moniker -Specify the 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 @@ -181,8 +195,8 @@ Accept wildcard characters: False ### -Name -Specify the WinGet package name. This should be the full package name. The name should be in -quotation marks if there is a space in the name. +Specify the name of the WinGet package name. The name contains space, you must enclose the name in +quotes. ```yaml Type: System.String @@ -198,7 +212,8 @@ Accept wildcard characters: False ### -PSCatalogPackage -WinGet package object. +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 @@ -214,7 +229,16 @@ Accept wildcard characters: False ### -Query -Search string. Wildcards are not supported. +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[] @@ -230,7 +254,7 @@ Accept wildcard characters: False ### -Source -Specify configured WinGet source. +Specify the name of a configured WinGet source. ```yaml Type: System.String @@ -246,7 +270,7 @@ Accept wildcard characters: False ### -Version -Specify the version. +Specify the version of the package to be uninstalled. ```yaml Type: System.String @@ -278,8 +302,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md index 89dcaa4df3..6422bbe230 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -10,7 +10,7 @@ title: Update-WinGetPackage # Update-WinGetPackage ## SYNOPSIS -Update a WinGet package. +Installs a newer version of a previously installed WinGet package. ## SYNTAX @@ -37,7 +37,11 @@ Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override ## DESCRIPTION -Updates the selected package found by searching the installed packages list. +This command searches the packages installed on your system and installs a newer version of the +matching WinGet package. The command includes parameters to specify values used to search for +packages in the configured sources. By default, the command searches all sources. By default, all +string-based searches are case-insensitive substring searches. Wildards are not supported. You can +change the search behavior using the **MatchOption** parameter. ## EXAMPLES @@ -47,9 +51,8 @@ Updates the selected package found by searching the installed packages list. Update-WinGetPackage Microsoft.PowerShell ``` -This sample updates the Microsoft.PowerShell package. No specific property to identify the query -string "Microsoft.PowerShell" as a package identifier. This is a convenient short form not requiring -the user to pass "-Id". +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 @@ -57,9 +60,10 @@ the user to pass "-Id". Update-WinGetPackage -Id Microsoft.PowerShell ``` -This sample updates the Microsoft.PowerShell package by the specifying the package identifier. - -> **If more than one source is configured with the same package identifier, the user must disambiguate** +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 @@ -75,14 +79,16 @@ This sample updates the PowerToys package by the specifying the package name. Update-WinGetPackage Microsoft.PowerShell -Version 7.4.4.0 ``` -This sample updates the Microsoft.PowerShell package to version 7.4.4.0. No specific property to -identify the query string "Microsoft.PowerShell" as a package identifier. +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 -Update the package even if the installer download SHA256 doesn't match the manifest. +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 @@ -98,7 +104,14 @@ Accept wildcard characters: False ### -Architecture -Specify the installer 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 @@ -115,7 +128,10 @@ Accept wildcard characters: False ### -Custom -Add additional arguments to the installer command. +Use this paramater 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 @@ -163,7 +179,8 @@ Accept wildcard characters: False ### -Id -Specify the package identifier. +Specify the package identifier to search for. By default, the command does a case-insensitive +substring match. ```yaml Type: System.String @@ -179,7 +196,8 @@ Accept wildcard characters: False ### -IncludeUnknown -Attempt to upgrade the package when the installed version is not specified in the registry. +Use this parameter to upgrade the package when the installed version is not specified in the +registry. ```yaml Type: System.Management.Automation.SwitchParameter @@ -195,7 +213,20 @@ Accept wildcard characters: False ### -InstallerType -Specify the installer type to use. +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 @@ -212,7 +243,9 @@ Accept wildcard characters: False ### -Locale -Specify the installer 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 @@ -228,9 +261,8 @@ Accept wildcard characters: False ### -Location -Specify the location to install the package. - -> **Note: Not all installers support this property.** +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 @@ -264,7 +296,12 @@ Accept wildcard characters: False ### -MatchOption -Specify the match type to use. +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 @@ -281,7 +318,13 @@ Accept wildcard characters: False ### -Mode -Specify the installer output mode. Options are "Default", "Silent", and "Interactive". +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 @@ -298,7 +341,8 @@ Accept wildcard characters: False ### -Moniker -Specify the 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 @@ -314,7 +358,7 @@ Accept wildcard characters: False ### -Name -Specify the name. +Specify the name of the package to be updated. ```yaml Type: System.String @@ -330,7 +374,10 @@ Accept wildcard characters: False ### -Override -Override the switches to pass to the installer. +Specify arguments to pass to the installer as a single string. To pass multiple arguments, include +the arguments in the string. The arguments must be provided in the format expected by the installer. +If the string contains spaces, it must be enclosed in quotes. This string overrides the arguments in +the package manifest. ```yaml Type: System.String @@ -346,7 +393,8 @@ Accept wildcard characters: False ### -PSCatalogPackage -WinGet package object +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 @@ -362,7 +410,16 @@ Accept wildcard characters: False ### -Query -Search string. Wildcards are not supported. +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[] @@ -378,7 +435,16 @@ Accept wildcard characters: False ### -Scope -Specify installer scope. Valid values are "Any", "User", "System", "UserOrUnknown", "SystemOrUnknown". +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 @@ -395,7 +461,7 @@ Accept wildcard characters: False ### -SkipDependencies -Skip dependency installation. +Specifies that the command shouldn't install the WinGet package dependencies. ```yaml Type: System.Management.Automation.SwitchParameter @@ -411,7 +477,7 @@ Accept wildcard characters: False ### -Source -Specify configured WinGet source. +Specify the name of a configured WinGet source. ```yaml Type: System.String @@ -459,8 +525,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter From 916269983d8d28dc94c8a2ebf70edce9a29f5224 Mon Sep 17 00:00:00 2001 From: ryfu-msft Date: Fri, 9 Aug 2024 13:02:15 -0700 Subject: [PATCH 52/55] address final comments --- .../Help/Microsoft.WinGet.Client/Export-WinGetPackage.md | 3 ++- .../Help/Microsoft.WinGet.Client/Find-WinGetPackage.md | 2 +- .../Help/Microsoft.WinGet.Client/Get-WinGetPackage.md | 3 +-- .../Help/Microsoft.WinGet.Client/Install-WinGetPackage.md | 4 ++-- .../Microsoft.WinGet.Client/Uninstall-WinGetPackage.md | 4 ++-- .../Help/Microsoft.WinGet.Client/Update-WinGetPackage.md | 8 +++----- 6 files changed, 11 insertions(+), 13 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md index ff09b8468d..ea73899c22 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Export-WinGetPackage.md @@ -257,7 +257,8 @@ Accept wildcard characters: False ### -PSCatalogPackage -Specify PSCatalogPackage +Provide **PSCatalogPackage** object. You can get a **PSCatalogPackage** object by using the +`Find-WinGetPackage` command. ```yaml Type: Microsoft.WinGet.Client.Engine.PSObjects.PSCatalogPackage diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md index 853822fa3a..30e3ed283e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Find-WinGetPackage.md @@ -67,7 +67,7 @@ searches all configured sources. The command performs a case-sensitive full text ### -Command -Specifies command used to run the package +Specify the name of the command defined in the package manifest. ```yaml Type: System.String diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md index 22f30d1203..6c8342b81e 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetPackage.md @@ -40,8 +40,7 @@ This example shows how to list all packages installed on your system. ### -Command -Specify the name of the command contained in the package. The command filters the results to -packages that match this value. +Specify the name of the command defined in the package manifest. ```yaml Type: System.String diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 18e4beea5b..6a09a545aa 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -121,7 +121,7 @@ Accept wildcard characters: False ### -Custom -Use this paramater to pass additional arguments to the installer. The parameter takes a single +Use this parameter to pass additional arguments to the installer. The parameter takes a single string 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. @@ -253,7 +253,7 @@ Accept wildcard characters: False ### -Log -Specify the location for the installer log to be written. +Specify the location for the installer log. The value can be a fully-qualified or relative path and must include the file name. For example: `$env:TEMP\package.log`. ```yaml Type: System.String diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md index eea2582071..91d92f7078 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Uninstall-WinGetPackage.md @@ -34,7 +34,7 @@ Uninstall-WinGetPackage [-Mode ] [-Force] [-Log This command uninstalls a WinGet package from your computer. The command includes parameters to specify values used to search for installed packages. By default, all string-based searches are -case-insensitive substring searches. Wildards are not supported. You can change the search behavior +case-insensitive substring searches. Wildcards are not supported. You can change the search behavior using the **MatchOption** parameter. ## EXAMPLES @@ -114,7 +114,7 @@ Accept wildcard characters: False ### -Log -Specify log location for uninstall. +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.** diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md index 6422bbe230..a756e15aad 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -39,9 +39,7 @@ Update-WinGetPackage [-IncludeUnknown] [-Mode ] [-Override This command searches the packages installed on your system and installs a newer version of the matching WinGet package. The command includes parameters to specify values used to search for -packages in the configured sources. By default, the command searches all sources. By default, all -string-based searches are case-insensitive substring searches. Wildards are not supported. You can -change the search behavior using the **MatchOption** parameter. +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 @@ -128,7 +126,7 @@ Accept wildcard characters: False ### -Custom -Use this paramater to pass additional arguments to the installer. The parameter takes a single +Use this parameter to pass additional arguments to the installer. The parameter takes a single string 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. @@ -278,7 +276,7 @@ Accept wildcard characters: False ### -Log -Specify the location for the installer 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.** From 963931dcd3e999ecb2c505c3e890060e3086decf Mon Sep 17 00:00:00 2001 From: ryfu-msft Date: Fri, 9 Aug 2024 13:16:44 -0700 Subject: [PATCH 53/55] fix spelling --- .../Microsoft.WinGet.Client/Get-WinGetSettings.md | 14 +++++++------- .../Install-WinGetPackage.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md index e73c0d2adf..6c828f7b28 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetSettings.md @@ -51,13 +51,13 @@ Get-WinGetSettings | Select-Object -ExpandProperty adminSettings ``` ```Output -Name Value ----- ----- -ProxyCommandLineOptions False -LocalArchiveMalwareScanOverri… False -InstallerHashOverride False -BypassCertificatePinningForMi… False -LocalManifestFiles False +Name Value +---- ----- +InstallerHashOverride False +ProxyCommandLineOptions False +BypassCertificatePinningForMicrosoftStore False +LocalArchiveMalwareScanOverride False +LocalManifestFiles True ``` ## PARAMETERS diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 6a09a545aa..53100f9a7f 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -40,7 +40,7 @@ Install-WinGetPackage [-Mode ] [-Override ] [-Cust 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. -Wildards are not supported. You can change the search behavior using the **MatchOption** parameter. +Wildcards are not supported. You can change the search behavior using the **MatchOption** parameter. ## EXAMPLES From b657d9b561a1fc071bf3ad99fe28bcee638f58b2 Mon Sep 17 00:00:00 2001 From: ryfu-msft Date: Mon, 12 Aug 2024 11:03:39 -0700 Subject: [PATCH 54/55] address Flor's comments --- .../Help/Microsoft.WinGet.Client/Add-WinGetSource.md | 4 ++-- .../Microsoft.WinGet.Client/Enable-WinGetSetting.md | 1 - .../Microsoft.WinGet.Client/Export-WinGetPackage.md | 2 +- .../Microsoft.WinGet.Client/Get-WinGetUserSettings.md | 2 +- .../Microsoft.WinGet.Client/Install-WinGetPackage.md | 10 ++-------- .../Microsoft.WinGet.Client/Remove-WinGetSource.md | 2 +- .../Repair-WinGetPackageManager.md | 5 +++-- .../Microsoft.WinGet.Client/Update-WinGetPackage.md | 10 ++-------- 8 files changed, 12 insertions(+), 24 deletions(-) diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md index 2882cc9cfb..ca1c4c9c71 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md @@ -21,7 +21,7 @@ Add-WinGetSource -Name -Argument [-Type ] [] [-AllowHashMismatch] 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 the your `Downloads` folder. You can use the **DownloadDirectory** parameter to change +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md index 8018b621a3..9c6ef88b23 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Get-WinGetUserSettings.md @@ -22,7 +22,7 @@ Get-WinGetUserSettings [] This command displays the WinGet settings for the current user. The settings are stored in `$env:LOCALAPPDATA\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\LocalState\settings.json`. -This file only exists if you have change a user setting using the `Set-WinGetUserSettings` command. +This file only exists if you have changed a user setting, for example, using the `Set-WinGetUserSettings` command. ## EXAMPLES diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md index 53100f9a7f..037d872cd4 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Install-WinGetPackage.md @@ -121,10 +121,7 @@ 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. +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 @@ -343,10 +340,7 @@ Accept wildcard characters: False ### -Override -Specify arguments to pass to the installer as a single string. To pass multiple arguments, include -the arguments in the string. The arguments must be provided in the format expected by the installer. -If the string contains spaces, it must be enclosed in quotes. This string overrides the arguments in -the package manifest. +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md index 40f0064f72..99c85f981c 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Remove-WinGetSource.md @@ -21,7 +21,7 @@ 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`. +`msstore` and `winget`. You can add more sources using `Add-WinGetSource`. This command must be executed with administrator permissions. ## EXAMPLES diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md index 0a06e96ef6..b0f6e28a69 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Repair-WinGetPackageManager.md @@ -30,8 +30,9 @@ 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. It ensures that the client is installed in a -working state. +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 diff --git a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md index a756e15aad..c222dfcbcd 100644 --- a/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md +++ b/src/PowerShell/Help/Microsoft.WinGet.Client/Update-WinGetPackage.md @@ -126,10 +126,7 @@ 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. +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 @@ -372,10 +369,7 @@ Accept wildcard characters: False ### -Override -Specify arguments to pass to the installer as a single string. To pass multiple arguments, include -the arguments in the string. The arguments must be provided in the format expected by the installer. -If the string contains spaces, it must be enclosed in quotes. This string overrides the arguments in -the package manifest. +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 From 5f5aa914e3c6e881c94fe5660a1c27739a85e703 Mon Sep 17 00:00:00 2001 From: ryfu-msft Date: Mon, 12 Aug 2024 11:09:54 -0700 Subject: [PATCH 55/55] fixSpelling --- .github/actions/spelling/expect.txt | 2 -- .github/actions/spelling/patterns.txt | 4 ++-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index 1d867e311a..261cb571f8 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -11,7 +11,6 @@ adml admx AFAIK aicli -arning AICLIC AKV allusers @@ -136,7 +135,6 @@ dsc DUPLICATEALIAS dustojnikhummer dvinns -ebug ecfr ecfrbrowse EFGH 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,})