PowerShell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Join the chat at https://gitter.im/PowerShell/PowerShellGet License Documentation - PowerShellGet PowerShell Gallery - PowerShellGet Minimum Supported PowerShell Version

Introduction

PowerShellGet is a PowerShell module with commands for discovering, installing, updating and publishing the PowerShell artifacts like Modules, DSC Resources, Role Capabilities and Scripts.

PowerShellGet module is also integrated with the PackageManagement module as a provider, users can also use the PackageManagement cmdlets for discovering, installing and updating the PowerShell artifacts like Modules and Scripts.

Build status

Development branch

OS - PS Version Build Status
AppVeyor (Windows - PS 4.0) d-av-image
AppVeyor (Windows - PS 5.1) d-av-image
AppVeyor (Windows - PS 6.0.0+) d-av-image
Travis CI (Linux - PS 6.0.0+) d-tv-image
Travis CI (MacOS - PS 6.0.0+) d-tv-image

Master branch

OS - PS Version Build Status
AppVeyor (Windows - PS 4.0) m-av-image
AppVeyor (Windows - PS 5.1) m-av-image
AppVeyor (Windows - PS 6.0.0+) m-av-image
Travis CI (Linux - PS 6.0.0+) m-tv-image
Travis CI (MacOS - PS 6.0.0+) m-tv-image

Daily Build status

Development branch

OS - PS Version Build Status
AppVeyor (Windows - PS 4.0) d-n-av-image
AppVeyor (Windows - PS 5.1) d-n-av-image
AppVeyor (Windows - PS 6.0.0+) d-n-av-image
Travis CI (Linux - PS 6.0.0+) d-tv-image
Travis CI (MacOS - PS 6.0.0+) d-tv-image

Documentation

Click here

Requirements

  • Windows PowerShell 3.0 or newer.
  • PowerShell Core.

Module Dependencies

  • PackageManagement module

Get PowerShellGet Module

Please refer to our documentation for the up-to-date version on how to get the PowerShellGet Module.

Get PowerShellGet Source

Steps

cd path/to/PowerShellGet
  • Import the module
Import-Module /path/to/PowerShellGet/PowerShellGet

Running Tests

Pester-based PowerShellGet Tests are located in <branch>/PowerShellGet/Tests folder.

Run following commands in PowerShell Console with Administrator privileges.

Import-Module "$ClonePath\tools\build.psm1"

Install-Dependencies

# Option 1: Execute the following, replacing $ClonePath, when testing PowerShellGet module changes under $ClonePath.
# $env:PSModulePath = "$ClonePath;$env:PSModulePath"

# Option 2: Execute the following commands to run tests with the merged PSModule.psm1
<#
Update-ModuleManifestFunctions
Publish-ModuleArtifacts
Install-PublishedModule
#>

# Run tests
Invoke-PowerShellGetTest

Contributing to PowerShellGet

You are welcome to contribute to this project. There are many ways to contribute:

  • Submit a bug report via Issues. For a guide to submitting good bug reports, please read Painless Bug Tracking.
  • Read the documentation on contributing to open source and forking.
  • Verify fixes for bugs.
  • Submit your fixes for a bug. Before submitting, please make sure you have:
    • Performed code reviews of your own
    • Updated the test cases if needed
    • Run the test cases to ensure no feature breaks or test breaks
    • Added the test cases for new code
  • Submit a feature request.
  • Help answer questions in the discussions list.
  • Submit test cases.
  • Tell others about the project.
  • Tell the developers how much you appreciate the product!

You might also read these two blog posts about contributing code: Open Source Contribution Etiquette by Miguel de Icaza, and Don’t “Push” Your Pull Requests by Ilya Grigorik.

Before submitting a feature or substantial code contribution, please discuss it with the Windows PowerShell team via Issues, and ensure it follows the product roadmap. Note that all code submissions will be rigorously reviewed by the Windows PowerShell Team. Only those that meet a high bar for both quality and roadmap fit will be merged into the source.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.