Reference Guide › AutoShell › AutoShell Core Reference › General AutoShell Commands › help Command--Request Help Information (Cmdlet)

help Command--Request Help Information (Cmdlet)

This command (cmdlet) displays help information for AutoShell commands, functions and classes and optionally redirects it to a file.

The command has the following syntax:

help [mask] [-output outFile]

mask

(Optional) Specifies the mask that is used to filter out the commands about which help information is needed. You can use the asterisk "*" and the question mark "?" as wildcards.

Default: "help"

outFile

(Optional) Specifies the absolute or relative path of the file to contain the help information. Any existing file with the same name and path is overwritten.

Default: ""

Example

Display help for the run-remote funclet:

help run-remote

Display help for the RemoteTarget class including all constructors and methods:

help RemoteTarget*

List all help topics and write them to a file:

help * -output help.txt