Build Environment

Overview

PrtgAPI is a cross platform project, compatible with Windows, macOS and Linux. As such, it is important that users on either of these platforms are able to compile PrtgAPI with ease. From a development perspective, it is also important that various aspects of the PrtgAPI project (such as unit tests, simulating CI, etc) can be easily tested on a variety of systems.

The PrtgAPI Build Environment provides a cross platform shell (accessible via build.cmd or build.sh in the repo root) capable of managing all aspects of the PrtgAPI project development lifecycle. A wide array of commands are available, all discoverable via the Get-PrtgCommand cmdlet:

Name	Category	Description
Clear-PrtgBuild	Build	Clears the output of one or more previous PrtgAPI builds
Invoke-PrtgBuild	Build	Compiles PrtgAPI from source
Get-PrtgCoverage	CI	Generates a code coverage report for PrtgAPI
New-PrtgPackage	CI	Creates NuGet packages from PrtgAPI for distribution
Simulate-PrtgCI	CI	Simulates building PrtgAPI under a Continuous Integration environment
Get-PrtgCommand	Help	Retrieves commands that are available in the PrtgAPI Build Environment
Get-PrtgHelp	Help	Opens the PrtgAPI Wiki for getting help compiling PrtgAPI
Get-PrtgTestResult	Test	Retrieve test results from the last invocation of Invoke-PrtgTest
Invoke-PrtgTest	Test	Executes tests on a PrtgAPI build
Get-PrtgLog	Utility	Continuously retrieves logs emitted by the PrtgAPI Build Environment
Install-PrtgDependency	Utility	Installs dependencies required to use the PrtgAPI Build Environment
Invoke-PrtgAnalyzer	Utility	Analyzes best practice rules on PrtgAPI PowerShell files
Start-PrtgAPI	Utility	Starts a new PowerShell console containing the compiled version of PrtgAPI
Get-PrtgVersion	Version	Retrieves version information used by various components of PrtgAPI
Set-PrtgVersion	Version	Sets the version of all components used when building PrtgAPI
Update-PrtgVersion	Version	Increments the version of all components used when building PrtgAPI

See Also

• Compilation
• Testing
• Version
• CI
• Dependencies