about_MergeScriptConfig

Requires PowerShell Pro Tools‚Äč

SHORT DESCRIPTION

About config hashtables for Merge-Script

LONG DESCRIPTION

This about file contains information about using hashtables and PSD1 files to configure Merge-Script.

Config File Schema

@{
Root = 'c:\Users\Adam\Desktop\service.ps1' # Root script to package. This is the main entry point for the package.
OutputPath = 'c:\Users\Adam\Desktop\out' # The output directory for the packaging process.
Package = @{
Enabled = $true # Whether to package as an executable.
Obfuscate = $false # Whether to obfuscate the resulting executable.
HideConsoleWindow = $false # Whether to hide the console window. Only valid for console applications.
DotNetVersion = 'v4.6.2' # The target .NET Framework version. You will need the .NET Developer Pack for this version installed on your machine.
FileVersion = '1.0.0' # The output file version
FileDescription = '' # The output file description
ProductName = '' # The output file product name
ProductVersion = '' # The output file product version.
Copyright = '' # The output file copyright
RequireElevation = $false # Whether to require elevation when running the executable. Only valid for console applications.
ApplicationIconPath = '' # The path to the application icon to use for the executable.
PackageType = 'Console' # The type of executable to generate. Valid values are Service or Console.
ServiceName = "" # The name of the service if the package type is Service.
ServiceDisplayName = "" # The display name of the service if the package type is Service.
PowerShellCore = $true # Whether to bundle the PowerShell Core runtime within your executable.
HighDPISupport = $true # Whether to enable high DPI support for WinForm applications
}
Bundle = @{
Enabled = $true # Whether to bundle multiple PS1s into a single PS1. Always enabled when Package is enabled.
Modules = $true # Whether to bundle modules into the package
}
}

Using a config file

A config file can be used either from within a PowerShell script as a hashtable or imported from a PSD1 file containing the hashtable.

EXAMPLES

It is not required to include all aspects of the config when using Merge-Script. The only required components are Root and OutputPath. Aside from that, anything that is not include will be considered false. This means that in the below example, packaging is disabled but bundling is not. The below operation will not bundle nested modules or required assemblies of any modules it is bundling.

Merge-Script -Config @{
Root = ".\MyScript.ps1"
OutputPath = ".\"
Bundle = @{
Enabled = $true
Modules = $true
}
}

Create console application

Creates a PowerShell console based application that has an application icon and hides the console window.

@{
Root = 'c:\Users\Adam\Desktop\form.ps1'
OutputPath = 'c:\Users\Adam\Desktop\out'
Package = @{
Enabled = $true
HideConsoleWindow = $true
DotNetVersion = 'v4.6.2'
ApplicationIconPath = 'C:\users\adam\desktop\icon.ico'
}
}

Create a service

Creates a PowerShell service based on the service.ps1 file and outputs to the out directory on the desktop. It will use the .NET 4.6.2 Developer Pack. The service name will be PSService and the display name will be PowerShell Service.

@{
Root = 'c:\Users\Adam\Desktop\service.ps1'
OutputPath = 'c:\Users\Adam\Desktop\out'
Package = @{
Enabled = $true
DotNetVersion = 'v4.6.2'
FileVersion = '1.0.0'
FileDescription = ''
ProductName = ''
ProductVersion = ''
Copyright = ''
PackageType = 'Service'
ServiceName = "PSService"
ServiceDisplayName = "PowerShell Service"
}
}

Bundle PowerShell Core Engine with your Script

Creates an executable that contains the PowerShell Core engine. This executable does not require the target machine have PowerShell Core or .NET Core installed. The size of the executable will be considerably larger than a typical Merge-Script executable.

@{
Root = 'c:\Users\Adam\Desktop\script.ps1'
OutputPath = 'c:\Users\Adam\Desktop\out'
Package = @{
Enabled = $true
PowerShellCore = $true
}
Bundle = @{
Enabled = $true
Modules = $true
}
}