Skip to content

Cmdlet Reference

PSScriptBuilder provides 29 public cmdlets across five categories.

Scaffolding

Cmdlet Description
New-PSScriptBuilderProject Scaffolds a new PSScriptBuilder project structure

Script Building

Cmdlet Description
New-PSScriptBuilderContentCollector Creates a new content collector for managing multiple component collectors
New-PSScriptBuilderCollector Creates a new collector for PowerShell script components
Add-PSScriptBuilderCollector Adds a collector to a ContentCollector for fluent pipeline configuration
Get-PSScriptBuilderCollector Retrieves collectors from a ContentCollector
Get-PSScriptBuilderCollectorContent Retrieves collected data from a collector
Remove-PSScriptBuilderCollector Removes a collector from a ContentCollector
Invoke-PSScriptBuilderBuild Executes the complete PowerShell script build process
Compress-PSScriptBuilderScript Post-processes a built PowerShell script by removing comments, blank lines, or output statements
Format-PSScriptBuilderBuildResult Formats and displays the result of a build operation

Analysis & Validation

Cmdlet Description
Get-PSScriptBuilderDependencyAnalysis Analyzes dependencies between components without performing a build
Get-PSScriptBuilderComponentDependency Retrieves all dependencies or dependents of a named component from the dependency graph
Export-PSScriptBuilderDependencyGraph Exports the dependency graph to a visual diagram format
ConvertTo-PSScriptBuilderComponentDependencyTree Converts component dependency entries to a hierarchical tree string
Get-PSScriptBuilderTemplateAnalysis Analyzes a template file for placeholders and structure
Test-PSScriptBuilderTemplate Validates a template file without performing a build

Configuration

Cmdlet Description
Get-PSScriptBuilderConfiguration Retrieves the global PSScriptBuilder configuration
New-PSScriptBuilderConfiguration Creates a new PSScriptBuilder configuration file with default values
Set-PSScriptBuilderProjectRoot Sets the PSScriptBuilder project root directory

Release Management

Cmdlet Description
New-PSScriptBuilderReleaseData Creates a new release data file with default values
Get-PSScriptBuilderReleaseData Retrieves the current release data configuration
Get-PSScriptBuilderReleaseDataTokens Retrieves available release data tokens for substitution in bump files
Test-PSScriptBuilderReleaseData Tests the release data file for validity
Update-PSScriptBuilderReleaseData Updates release data including version and metadata
Format-PSScriptBuilderReleaseDataResult Formats and displays the result of a release data update operation
Get-PSScriptBuilderBumpConfiguration Retrieves the bump configuration
Test-PSScriptBuilderBumpConfiguration Tests the bump configuration file for validity
Update-PSScriptBuilderBumpFiles Updates configured project files with current version information
Format-PSScriptBuilderBumpResult Formats and displays the result of a bump operation