Skip to content

Clear‑ShpContext

Raimund edited this page Aug 26, 2026 · 2 revisions

SYNOPSIS

Resets the ShellPilot session context to its built-in defaults.

SYNTAX

Clear-ShpContext [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Clears every option held in the module-scoped session context set by Set-ShpContext, so that subsequent Invoke-Shp and other API calls fall back to the built-in defaults for HTTP timeout and retry behaviour, stop using any alternative backend (ApiBase / ApiKey), and stop using an in-memory GitHub OAuth token (GitHubToken). Affects only the current PowerShell session; nothing is persisted to disk.

EXAMPLES

EXAMPLE 1

Clear-ShpContext

Forgets all session connection options and returns to the defaults.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

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

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

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

OUTPUTS

None.

NOTES

RELATED LINKS

Set-ShpContext

Get-ShpContext

Clone this wiki locally