Skip to main content

Getting Help

Built-in Help​

View Available Tasks​

To see a list of all tasks defined in your psake build script, use the -Docs parameter:

Invoke-psake -Docs

This will print the current tasks list from your psake file, showing all available tasks and their descriptions.

PowerShell Help System​

You can use the PowerShell Get-Help command on the Invoke-psake function to get detailed help:

# First import the psake module
Import-Module psake

# View full help for Invoke-psake
Get-Help Invoke-psake -Full

List Available Commands​

To see all functions available in the psake module:

Get-Command -Module psake

# Output:
# CommandType     Name                Definition
# -----------     ----                ----------
# Function        Assert              ...
# Function        Exec                ...
# Function        FormatTaskName      ...
# Function        Include             ...
# Function        Invoke-psake        ...
# Function        Properties          ...
# Function        Task                ...
# Function        TaskSetup           ...
# Function        TaskTearDown        ...

Get Examples for Specific Commands​

Use Get-Help with the -Examples parameter to see usage examples:

Get-Help Assert -Examples

# Output:
# NAME
#     Assert
#
# SYNOPSIS
#     Helper function for "Design by Contract" assertion checking.
#
# -------------------------- EXAMPLE 1 --------------------------
# Assert $false "This always throws an exception"
#
# -------------------------- EXAMPLE 2 --------------------------
# Assert ( ($i % 2) -eq 0 ) "$i is not an even number"

Community Support​

Need help with your build scripts? The psake community is here to help!

Chat & Discussion​

Q&A​

  • Stack Overflow - Search existing questions or ask new ones using the psake tag

Report Issues​

Found a bug or have a feature request?

  • GitHub Issues - Report bugs or request features in the main psake repository

Documentation​

For comprehensive guides and reference materials: