Introduction

PowerPlug is a PowerShell 7 cmdlet library. The main mission of PowerPlug is to make PowerShell development faster and eaiser. PowerPlug is run through C# PSCmdlet classes from the PowerShell Standard Library. PowerPlug is driven by the Ampere Library.

Execution

Install from PS Gallery

You can install the latest release to PowerShell 7 by running:

Install-Module -Name PowerPlug

Install from GitHub Releases

The latest zip release can be found under the Github Releases Page. You can use the PowerPlug.dll binary and place it within any other directory, but conventionally in $env:PSModulePath.

Importing into session

To import the dll for the session, you can run: ipmo PowerPlug or Import-Module PowerPlug. You can use the previous commands within the $PROFILE to load the library on PowerShell startup. Run Get-Module PowerPlug to confirm the import ran successfully.

Contributing

We are actively looking for contributors to work on all aspects of the code base ― from documentation to C# Cmdlet utilities. For more information onn how to contribute, view our CONTRIBUTING.md

Building PowerPlug

Prerequisites:

• PowerShell 7.0 or Later
• Visual Studio 2017 or Later OR VSCode
• .NET 5

The default language setting for this project is C# 9.0. The project can be built using dotnet build and the output will display the AssemblyPath. PowerShell 7 can be set as the startup item on Visual Studio to dynamically debug PowerPlug.

Documentation

There are three components to PowerPlug documentation:

1. Assembly Documentation
2. PowerShell Help File Documentation
3. Miscellaneous Documentation (README.md, Wiki's, Discussions, etc...)

All PowerPlug methods are documented using .NET XML documentation for better understanding. In addition, the PowerPlug.dll-Help.xml file is the MAML file that is used to generate the Get-Help documentation for PowerPlug cmdlets. Lastly, as a fluid repository, many files change and constantly need to be documented and updated.

Roadmap

There are two planned releases - the latest being by September 2021:

• 0.3.0 - Full release with a additional cmdlets in its own library, comprehensive documentation in the code-base and PowerShell, robust cmdlets
• 0.4.0 - Ampere Wrappers

State

PowerPlug is a very fluid project and you may encounter issues during execution, especially for preleases. To report an issue visit, PowerPlug Issues, or to contribute, view the contribution guidelines.

Licensing

PowerPlug is licensed under the GNU General Public License v3.0. The GNU General Public License is a free, copyleft license for software and other kinds of works.

Acknowledgements

Thanks especially to my fellow friends and contributors

• Sam Yuen
• Lok Kwong