Open-PSWorkItemHelp

June 16, 2025 ยท View on GitHub

SYNOPSIS

Open the PSWorkItem help document

SYNTAX

Open-PSWorkItemHelp [-AsMarkdown] [<CommonParameters>]

DESCRIPTION

Use this command to open the PDF help document for the PSWorkItem module with the associated application for PDF files. As an alternative you can view the documentation as a markdown document.

EXAMPLES

Example 1

PS C:\> Open-PSWorkItemHelp

The file should open in the default application for PDF files.

Example 2

PS C:\> Open-PSWorkItemHelp -AsMarkdown | more

View the help file a markdown document.

PARAMETERS

-AsMarkdown

Open the README help file as a Markdown document.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: md

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

None

System.String

NOTES

PSWorkItem GitHub Repository: