Verbose and debug output in PowerShell

Introduction

Verbose and debug output help you see extra details about what your script is doing. This makes it easier to find and fix problems.

When you want to understand how a script works step-by-step.

When you need to find out why a script is not working as expected.

When you want to get extra information without changing the main output.

When you are writing a script and want to check if parts of it run correctly.

When you want to share detailed script information with others for help.

Syntax

PowerShell

Write-Verbose "message"
Write-Debug "message"

Use Write-Verbose to show extra information that helps understand the script flow.

Use Write-Debug to show detailed debugging information, usually more technical.

Examples

This shows a verbose message if verbose output is enabled.

PowerShell

Write-Verbose "Starting the process..."

This shows a debug message if debug output is enabled.

PowerShell

Write-Debug "Variable x has value 10"

You can enable verbose output by adding -Verbose when running the script.

PowerShell

Write-Verbose "Step 1 completed"

You can enable debug output by adding -Debug when running the script.

PowerShell

Write-Debug "Checking condition"

Sample Program

This script defines a function that writes verbose and debug messages. When run with -Verbose and -Debug, it shows these messages along with the normal output.

PowerShell

function Test-VerboseDebug {
    param()
    Write-Verbose "Verbose: Starting function"
    Write-Debug "Debug: Checking variables"
    $x = 5
    Write-Verbose "Verbose: Variable x is $x"
    Write-Debug "Debug: Variable x type is $($x.GetType().Name)"
    Write-Output "Function completed"
}

# Run with verbose and debug enabled
Test-VerboseDebug -Verbose -Debug

Important Notes

Verbose and debug messages do not show unless you run the script with -Verbose or -Debug switches.

Use verbose for general extra info and debug for detailed technical info.

You can control the output level to avoid cluttering the screen with too many messages.

Summary

Verbose and debug output help you see extra script details without changing main results.

Use Write-Verbose and Write-Debug commands to add these messages in your script.

Enable messages by running scripts with -Verbose or -Debug options.