Home

Welcome to the Chocolatey Community Chocolatey Extensions wiki!

The repository currently contains several community-maintained Chocolatey extension packages. This wiki will be used to provide details on the content and usage of those extension packages.

Extensions

Chocolatey Core Extensions

This is a extension package that provides helper functions installed as a Chocolatey extension. These functions may be used in Chocolatey install/uninstall scripts by declaring this package a dependency in your package's nuspec. This package provides helper functions that can be used to enhance what is already available out of the box with Chocolatey CLI. This includes both features that are being tested for Chocolatey CLI itself, and other helpers to make the maintenance of Chocolatey packages easier.

Helpers that were available in this package, and were later added to Chocolatey CLI, will be moved to the package chocolatey-compatibility.extension.

Backwards compatibility is not considered for helpers available in this package.

Included Functions

• Get-AppInstallLocation
  Get an application install location.
• Get-AvailableDriveLetter
  Get a not yet in-use drive letter that can be used for mounting disks.
• Get-EffectiveProxy
  Gets the current proxy using several methods.
• Get-PackageCacheLocation
  Get a temporary location for files during the package operation based on the package its name and version.
• Get-WebContent
  This function will download a file from specified url and return it as a string. Intended as a replacement for WebClient in install scripts.
• Register-Application
  The function will register application in the system using App Paths registry key so that you can start it by typing its registered name in the Windows Start menu on using run dialog (Win + R).
• Remove-Process
  Ensure that a given process is stopped in a reliable way.

Chocolatey Compatibility Extension

This package provides helper functions that re-introduces helpers that were removed or updated in Chocolatey, as well as helpers that are not available in older version of Chocolatey CLI. The purpose of the package is to allow older packages to keep functioning even on later versions of Chocolatey CLI where certain helpers have been removed.

The helpers included in this package may not have any logic to handle the functionality to keep existing, but rather to ensure that packages using the helpers do not stop working.

You should not implement new packages using these functions.

Included Functions

• Get-PackageParameters
  This is a functional addition to the extension that enables versions of Chocolatey older than 0.10.8 (when the function was added to the Chocolatey helpers) to work with packages written for the new helper function.
• Get-UninstallRegistryKey
  This is a functional addition to the extension that enables versions of Chocolatey older than 0.10.3(?) to work with packages written for the new helper function.
• Install-ChocolateyDesktopLink
  This is a functional addition to the extension that warns packages that use Install-ChocolateyDesktopLink (whilst maintaining functionality), allowing packages written for versions of Chocolatey older than 1.0.0 to continue working. This was replaced by the helper function Install-ChocolateyShortcut.
• Write-ChocolateyFailure
  This is a functional addition to the extension that warns packages that use Write-ChocolateyFailure (whilst maintaining functionality), allowing packages written for versions of Chocolatey older than 1.0.0 to continue working.
• Write-ChocolateySuccess
  This is a functional addition to the extension that warns packages that use Write-ChocolateyFailure (whilst maintaining functionality), allowing packages written for versions of Chocolatey older than 1.0.0 to continue working.
• Write-FileUpdateLog
  This is a non-functional addition to the extension that warns if it is called without doing anything, allowing packages written for versions of Chocolatey older than 1.0.0 to continue working.