Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ethanbergstrom/winget

PackageManagement (OneGet) package provider for use with Windows Package Manager (winget)
https://github.com/ethanbergstrom/winget

Last synced: 9 days ago
JSON representation

PackageManagement (OneGet) package provider for use with Windows Package Manager (winget)

Host: GitHub
URL: https://github.com/ethanbergstrom/winget
Owner: ethanbergstrom
License: mit
Created: 2020-05-20T08:38:08.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-06-04T14:53:59.000Z (over 1 year ago)
Last Synced: 2024-08-14T07:06:55.556Z (4 months ago)
Language: PowerShell
Size: 98.6 KB
Stars: 46
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

jimsghstars - ethanbergstrom/winget - PackageManagement (OneGet) package provider for use with Windows Package Manager (winget) (PowerShell)

README

[![CI](https://github.com/ethanbergstrom/winget/actions/workflows/CI.yml/badge.svg)](https://github.com/ethanbergstrom/winget/actions/workflows/CI.yml)

# WinGet for PackageManagement
WinGet for PackageManagement facilitates installing WinGet packages from any compatible repository. The provider is heavily influenced by the work of the [ChocolateyGet](https://github.com/jianyunt/ChocolateyGet) project.

## 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](https://www.microsoft.com/en-us/p/app-installer/9nblggh4nns1?activetab=pivot:overviewtab) package.

**The WinGet Package Management Provider does not install the WinGet CLI utility. Please make sure the WinGet CLI utility is functional before attempting to use the WinGet PackageManagement provider!**

## Install WinGet
```PowerShell
Install-PackageProvider WinGet -Force
```
Note: Please do **not** use `Import-Module` with Package Management providers, as they are not meant to be imported in that manner. Either use `Import-PackageProvider` or specify the provider name with the `-Provider` argument to the PackageManagement cmdlets, such as in the examples below:

## Sample usages
### Search for a package
```PowerShell
Find-Package OpenJS.NodeJS -Provider WinGet

Find-Package Mozilla.Firefox -Provider WinGet -Detailed
```

### Find all available versions of a package
```PowerShell
Find-Package Mozilla.Firefox -Provider WinGet -AllVersions
```

### Install a package
```PowerShell
Find-Package OpenJS.NodeJS -Provider WinGet | Install-Package -Force

Install-Package Git.Git -Provider WinGet -Force
```

### Get list of installed packages (with wildcard search support)
```PowerShell
Get-Package Microsoft.* -Provider WinGet
```

### Uninstall a package
```PowerShell
Get-Package OpenJS.NodeJS -Provider WinGet | Uninstall-Package

Uninstall-Package Git.Git -Provider WinGet
```

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

The WinGet PackageManagement provider integrates with WinGet.exe to manage and store package source information.

## DSC Compatibility
Fully compatible with the PackageManagement DSC resources
```PowerShell
Configuration MyNode {
Import-DscResource PackageManagement,PackageManagementSource
PackageManagement WinGet {
Name = 'WinGet'
Source = 'PSGallery'
}
PackageManagementSource WinGetPrivateRepo {
Name = 'privateRepo'
ProviderName = 'WinGet'
SourceLocation = 'https://somewhere/out/there/cache'
InstallationPolicy = 'Trusted'
DependsOn = '[PackageManagement]WinGet'
}
PackageManagement NodeJS {
Name = 'OpenJS.NodeJS'
Source = 'privateRepo'
DependsOn = '[PackageManagementSource]WinGetPrivateRepo'
}
}
```

## Keep packages up to date
A common complaint of PackageManagement/OneGet is it doesn't allow for updating installed packages, while WinGet does.
In order to reconcile the two, WinGet has a reserved keyword 'latest' that when passed as a Required Version can compare the version of what's currently installed against what's in the repository.
```PowerShell

PS C:\Users\ethan> Get-Package OpenJS.NodeJS -Provider WinGet

Name Version Source Summary
---- ------- ------ -------
OpenJS.NodeJS 16.0.0 winget

PS C:\Users\ethan> Get-Package OpenJS.NodeJS -Provider WinGet -RequiredVersion latest
Get-Package : No package found for 'OpenJS.NodeJS'.

PS C:\Users\ethan> Install-Package OpenJS.NodeJS -Provider WinGet -Force

Name Version Source Summary
---- ------- ------ -------
OpenJS.NodeJS 17.2.0 winget

PS C:\Users\ethan> Get-Package OpenJS.NodeJS -Provider WinGet -RequiredVersion latest

Name Version Source Summary
---- ------- ------ -------
OpenJS.NodeJS 17.2.0 winget

```

This feature can be combined with a PackageManagement-compatible configuration management system (ex: [PowerShell DSC LCM in 'ApplyAndAutoCorrect' mode](https://docs.microsoft.com/en-us/powershell/scripting/dsc/managing-nodes/metaconfig)) to regularly keep certain packages up to date:
```PowerShell
Configuration MyNode {
Import-DscResource PackageManagement
PackageManagement WinGet {
Name = 'WinGet'
Source = 'PSGallery'
}
PackageManagement NodeJS {
Name = 'OpenJS.NodeJS'
RequiredVersion = 'latest'
ProviderName = 'WinGet'
DependsOn = '[PackageManagement]WinGet'
}
}
```

**Please note** - Since PackageManagement doesn't support passing source information when invoking `Get-Package`, the 'latest' functionality **will not work** if the default WinGet package source is removed as a source **and** multiple custom sources are defined.

Furthermore, if both the default WinGet package source and a custom source are configured, the custom source **will be ignored** when the 'latest' required version is used with `Get-Package`.

Example PowerShell DSC configuration using the 'latest' required version with a custom source:

```PowerShell
Configuration MyNode {
Import-DscResource PackageManagement,PackageManagementSource
PackageManagement WinGet {
Name = 'WinGet'
Source = 'PSGallery'
}
PackageManagementSource WinGetPrivateRepo {
Name = 'privateRepo'
ProviderName = 'WinGet'
SourceLocation = 'https://somewhere/out/there/cache'
InstallationPolicy = 'Trusted'
DependsOn = '[PackageManagement]WinGet'
}
PackageManagementSource WinGetRepo {
Name = 'WinGet'
ProviderName = 'WinGet'
Ensure = 'Absent'
DependsOn = '[PackageManagement]WinGet'
}
# The source information wont actually be used by the Get-Package step of the PackageManagement DSC resource check, but it helps make clear to the reader where the package should come from
PackageManagement NodeJS {
Name = 'OpenJS.NodeJS'
ProviderName = 'WinGet'
Source = 'privateRepo'
RequiredVersion = 'latest'
DependsOn = @('[PackageManagementSource]WinGetPrivateRepo', '[PackageManagementSource]WinGetRepo')
}
}
```

A working example PowerShell DSC script with automatic package updates can be found [here](https://gist.github.com/ethanbergstrom/9a4a0d29ea0452ef46bba580a7567d98).

If using the 'latest' functionality, best practice is to either:
* use the default WinGet source
* unregister the default WinGet source in favor of a **single** custom source

## Known Issues
WinGet is still in a preview period, with many features not implemented that are required for a PackageManagement provider to be fully implemented.

Unsupported features currently include:
* Passing install arguments to packages
* Saving a package

## Legal and Licensing
WinGet is licensed under the [MIT license](./LICENSE.txt).