-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PowerShell Help for Microsoft.WinGet.Client (#4674)
- Loading branch information
Showing
24 changed files
with
3,847 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
109 changes: 109 additions & 0 deletions
109
src/PowerShell/Help/Microsoft.WinGet.Client/Add-WinGetSource.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| --- | ||
| external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml | ||
| Module Name: Microsoft.WinGet.Client | ||
| ms.date: 08/01/2024 | ||
| online version: | ||
| schema: 2.0.0 | ||
| title: Add-WinGetSource | ||
| --- | ||
|
|
||
| # Add-WinGetSource | ||
|
|
||
| ## SYNOPSIS | ||
| Adds a new source. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Add-WinGetSource -Name <String> -Argument <String> [-Type <String>] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| Adds a new source. A source provides the data for you to discover and install packages. Only add a | ||
| new source if you trust it as a secure location. This command must be executed with administrator permissions. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1: Add new REST source named mysource | ||
|
|
||
| ```powershell | ||
| Add-WinGetSource -Name mysource -Argument https://contoso.com/ -Type Microsoft.Rest | ||
| ``` | ||
|
|
||
| This example adds a new REST source to WinGet named `mysource` with the root URL | ||
| `https://contoso.com/`. The source must respond with the WinGet REST source API. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Argument | ||
|
|
||
| The URL or UNC of either a pre-indexed WinGet source or a WinGet REST source API. | ||
|
|
||
| ```yaml | ||
| Type: System.String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
|
|
||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: True (ByPropertyName, ByValue) | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### -Name | ||
| The name used to identify the WinGet source. | ||
| ```yaml | ||
| Type: System.String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
|
|
||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: True (ByPropertyName, ByValue) | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### -Type | ||
| The type of the WinGet source. Most sources are `Microsoft.Rest`. The WinGet community repository | ||
| is `Microsoft.PreIndexed.Package`. | ||
|
|
||
| ```yaml | ||
| Type: System.String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: True (ByPropertyName, ByValue) | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### CommonParameters | ||
|
|
||
| This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, | ||
| -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, | ||
| -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see | ||
| [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ### System.String | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
|
|
||
| ## NOTES | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Remove-WinGetSource](Remove-WinGetSource.md) | ||
|
|
||
| [Reset-WinGetSource](Reset-WinGetSource.md) |
147 changes: 147 additions & 0 deletions
147
src/PowerShell/Help/Microsoft.WinGet.Client/Assert-WinGetPackageManager.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| --- | ||
| external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml | ||
| Module Name: Microsoft.WinGet.Client | ||
| ms.date: 08/01/2024 | ||
| online version: | ||
| schema: 2.0.0 | ||
| title: Assert-WinGetPackageManager | ||
| --- | ||
|
|
||
| # Assert-WinGetPackageManager | ||
|
|
||
| ## SYNOPSIS | ||
| Verifies that WinGet is installed properly. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ### IntegrityVersionSet (Default) | ||
|
|
||
| ``` | ||
| Assert-WinGetPackageManager [-Version <String>] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ### IntegrityLatestSet | ||
|
|
||
| ``` | ||
| Assert-WinGetPackageManager [-Latest] [-IncludePreRelease] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| Verifies that WinGet is installed properly. | ||
|
|
||
| > [!NOTE] | ||
| > The cmdlet doesn't ensure that the latest version of WinGet is installed. It just verifies that | ||
| > the installed version of Winget is supported by installed version of the Microsoft.WinGet.Client | ||
| > module. | ||
| ## EXAMPLES | ||
|
|
||
| ### Example 1: Default usage | ||
|
|
||
| ```powershell | ||
| Assert-WinGetPackageManager | ||
| ``` | ||
|
|
||
| If the current version of WinGet is installed correctly, the command returns without error. | ||
|
|
||
| ### Example 2: Check if latest stable version is installed | ||
|
|
||
| ```powershell | ||
| Assert-WinGetPackageManager -Latest | ||
| ``` | ||
|
|
||
| If the latest version of WinGet is compatible with the installed Microsoft.WinGet.Client module, the | ||
| command returns without error. | ||
|
|
||
| ### Example 3: Check if latest preview version is installed | ||
|
|
||
| ```powershell | ||
| Assert-WinGetPackageManager -IncludePreRelease | ||
| ``` | ||
|
|
||
| If the prerelease version of WinGet is compatible with the installed Microsoft.WinGet.Client module, | ||
| the command returns without error. | ||
|
|
||
| ### Example 4: Check if specific version is installed | ||
|
|
||
| ```powershell | ||
| Assert-WinGetPackageManager -Version v1.8.1911 | ||
| ``` | ||
|
|
||
| If the specified version of WinGet is compatible with the installed Microsoft.WinGet.Client module, | ||
| the command returns without error. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -IncludePreRelease | ||
|
|
||
| Include preview versions of WinGet. | ||
|
|
||
| ```yaml | ||
| Type: System.Management.Automation.SwitchParameter | ||
| Parameter Sets: IntegrityLatestSet | ||
| Aliases: | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: True (ByPropertyName) | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### -Latest | ||
| Verify that the latest version of WinGet is compatible with the installed version of the | ||
| Microsoft.WinGet.Client module. | ||
| ```yaml | ||
| Type: System.Management.Automation.SwitchParameter | ||
| Parameter Sets: IntegrityLatestSet | ||
| Aliases: | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: True (ByPropertyName) | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### -Version | ||
| Verify that a specific version of WinGet is installed correctly. | ||
| ```yaml | ||
| Type: System.String | ||
| Parameter Sets: IntegrityVersionSet | ||
| Aliases: | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: True (ByPropertyName) | ||
| Accept wildcard characters: False | ||
| ``` | ||
| ### CommonParameters | ||
| This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, | ||
| -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, | ||
| -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see | ||
| [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
| ## INPUTS | ||
| ### System.String | ||
| ### System.Management.Automation.SwitchParameter | ||
| ## OUTPUTS | ||
| ### System.Object | ||
| ## NOTES | ||
| ## RELATED LINKS | ||
| [Get-WinGetVersion](Get-WinGetVersion.md) |
Oops, something went wrong.