Skip to content

Latest commit

 

History

History
86 lines (56 loc) · 2.88 KB

README.md

File metadata and controls

86 lines (56 loc) · 2.88 KB

AnyPackage.WinGet

gallery-image build-image cf-image

AnyPackage.WinGet is an AnyPackage provider that facilitates installing WinGet packages from any compatible repository.

Requirements

Your machine must have at least Windows 10 1709 or Windows 11 and either PowerShell 5.1+ or PowerShell 7.0.1+, and the WinGet CLI utility installed. It may be already installed on your machine, but if not, Microsoft's recommended method for installing WinGet is via the Microsoft Store as part of the App Installer package.

Install AnyPackage.WinGet

Install-Module AnyPackage.WinGet -Force

Import AnyPackage.WinGet

Import-Module AnyPackage.WinGet

Sample usages

Search for a package

Find-Package -Name OpenJS.NodeJS

Find-Package -Name Mozilla.Firefox

Install a package

Find-Package OpenJS.NodeJS | Install-Package

Install-Package -Name Git.Git

Get list of installed packages (with wildcard search support)

Get-Package Microsoft.*

Uninstall a package

Get-Package OpenJS.NodeJS| Uninstall-Package
Uninstall-Package Git.Git

Manage package sources

Register-PackageSource privateRepo -Provider WinGet -Location 'https://somewhere/out/there/cache'
Find-Package OpenJS.NodeJS -Source privateRepo | Install-Package
Unregister-PackageSource privateRepo

AnyPackage.WinGet integrates with WinGet.exe to manage and store source information.

Known Issues

Stability

WinGet does not currently have an official module available on PowerShell Gallery, therefore this provider currently depends on a Cresendo module that is a best-effort attempt at parsing WinGet's output. Due to WinGet still being heavily in development, it's output patterns fluctuate regularly, making a Cresdendo-based implementation very brittle. As such, currently this provider should not be used in production scenarios.

Search Specificity

Due to WinGet's ambiguous search behavior and the risks of unintended outcomes, this provider only allows searching of packages on remote repositories by exact package ID. Fuzzy searches and searches by moniker, display name, and tag are not supported.

Legal and Licensing

AnyPackage.WinGet is licensed under the MIT license.