# Help

There are multiple methods of accessing help documentation in SPE to provide you with information on the commands available to you.

## Viewing all available commands

A report is available which will show you all available SPE commands:

![Accessing the report](/files/-Lmk9pxJZEdR2ktWKc1o)

When executed, this report provides a paged view of the SPE commands.

![Paged results of commands](/files/-Lmk9pxLw__HKVysDQ6g)

## Viewing command help

### Console

To display the available help for a command in the Console, simply use the Get-Help command:

```powershell
Get-Help Get-Rendering
```

For full documentation, including examples, use the `-Full` parameter:

```powershell
Get-Help Get-Rendering -Full
```

### ISE

Through the Integrated Scripting Environment (ISE), SPE provides a method of acccessing help for available commands. To view the help for a command, simply highlight the command and press Ctrl + Enter.

![Highlight the command and press Ctrl + Enter](/files/-Lmk9pxNpWAAynh8oOKe)

After doing this, a dialog will appear with the relevant help information:

![A help dialog for Get-Rendering](/files/-Lmk9pxPbhhHENCqW-7b)

## Documenting functions

When writing scripts, you are able to include formatted comments that will be used to provide help text for functions. If formatted correctly, this help text will be available through the methods described above.

**Example:** A simple function with documentation:

```powershell
<#
    .SYNOPSIS 
    A short synopsis of this function.
    .DESCRIPTION
    A much more detailed description of this function, which outputs a value.
    .PARAMETER Value
    The value that will be output 
    .EXAMPLE
    PS> Output-Value "My value"
    My value
#>
Function Output-String
{
    param(
        [string]$value
    )

    Write-Host $value
} 
```

Once the script containing this function has been invoked, the help text will be available:

```powershell
Get-Help Output-String
```

For further information on comment-based help, refer to the [official PowerShell documentation](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help).

## Online appendix

Online help is additionaly available for all SPE commands in this documentation, with detailed explanations of commands and their parameters, along with useful examples. These can be found in the [Command Appendix](/appendix.md).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.sitecorepowershell.com/interfaces/help.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.