Export-HtmlBrowserRecipe

August 3, 2026 ยท View on GitHub

SYNOPSIS

Exports a browser recipe object or current session recording snapshot to JSON.

SYNTAX

Recipe (Default)

Export-HtmlBrowserRecipe [-Recipe] <HtmlBrowserRecipe> [-Path] <string> [-PassThru] [-VariableTemplatePath <string>] [-IncludeOptionalVariables] [-CancellationToken <CancellationToken>] [<CommonParameters>]

Session

Export-HtmlBrowserRecipe [[-Session] <HtmlBrowserSession>] [-Path] <string> [-PassThru] [-VariableTemplatePath <string>] [-IncludeOptionalVariables] [-HardenSelectors] [-SelectorAlternateLimit <int>] [-ReplaceSelectorAlternates] [-HardeningReportPath <string>] [-CancellationToken <CancellationToken>] [<CommonParameters>]

DESCRIPTION

Exports a browser recipe object or current session recording snapshot to JSON.

EXAMPLES

EXAMPLE 1

Export-HtmlBrowserRecipe -Recipe $recipe -Path .\browser.recipe.json -VariableTemplatePath .\browser.recipe.variables.json

EXAMPLE 2

Export-HtmlBrowserRecipe -Session $session -Path .\browser.recipe.json -HardenSelectors

PARAMETERS

-CancellationToken

Token used to cancel the operation.

Type: CancellationToken
Parameter Sets: Recipe, Session
Aliases: None
Possible values:

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

-HardeningReportPath

Optional JSON path where a redacted selector hardening report should be written.

Type: String
Parameter Sets: Session
Aliases: None
Possible values:

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

-HardenSelectors

Add safe selector alternates from the current page before saving a session recording snapshot.

Type: SwitchParameter
Parameter Sets: Session
Aliases: None
Possible values:

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

-IncludeOptionalVariables

Include optional ValueVariable entries that already have stored fallback values in the variable template.

Type: SwitchParameter
Parameter Sets: Recipe, Session
Aliases: None
Possible values:

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

-PassThru

Return the recipe object instead of the output path.

Type: SwitchParameter
Parameter Sets: Recipe, Session
Aliases: None
Possible values:

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

-Path

Output JSON path.

Type: String
Parameter Sets: Recipe, Session
Aliases: None
Possible values:

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

-Recipe

Recipe object to export.

Type: HtmlBrowserRecipe
Parameter Sets: Recipe
Aliases: None
Possible values:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ReplaceSelectorAlternates

Replace existing selector alternates during hardening instead of appending missing alternates.

Type: SwitchParameter
Parameter Sets: Session
Aliases: None
Possible values:

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

-SelectorAlternateLimit

Maximum selector alternates to keep per selector-based step when HardenSelectors is used.

Type: Int32
Parameter Sets: Session
Aliases: None
Possible values:

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

-Session

Session whose active or stopped recording should be exported.

Type: HtmlBrowserSession
Parameter Sets: Session
Aliases: None
Possible values:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-VariableTemplatePath

Optional JSON path where a runtime variable template should be written.

Type: String
Parameter Sets: Recipe, Session
Aliases: None
Possible values:

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

  • HtmlTinkerX.HtmlBrowserRecipe
  • HtmlTinkerX.HtmlBrowserSession

OUTPUTS

  • System.String
  • HtmlTinkerX.HtmlBrowserRecipe
  • None