Invoke-HtmlPageWorkbench

August 3, 2026 ยท View on GitHub

SYNOPSIS

Builds a one-page extraction workbench result with text, Markdown, data, forms, endpoints, and guidance.

SYNTAX

Content (Default)

Invoke-HtmlPageWorkbench [-Content] <string> [-BaseUrl <uri>] [-IncludeLinkedScripts] [-IncludeExternalLinkedScripts] [-RenderedSnapshot <HtmlRenderedPageSnapshot>] [-NoStaticRenderedComparison] [-NoHtml] [-Proxy <string>] [-ProxyCredential <pscredential>] [<CommonParameters>]

Url

Invoke-HtmlPageWorkbench [-Url] <uri> [-IncludeLinkedScripts] [-IncludeExternalLinkedScripts] [-RenderedSnapshot <HtmlRenderedPageSnapshot>] [-NoStaticRenderedComparison] [-NoHtml] [-Proxy <string>] [-ProxyCredential <pscredential>] [<CommonParameters>]

Path

Invoke-HtmlPageWorkbench [-Path] <string> [-BaseUrl <uri>] [-IncludeLinkedScripts] [-IncludeExternalLinkedScripts] [-RenderedSnapshot <HtmlRenderedPageSnapshot>] [-NoStaticRenderedComparison] [-NoHtml] [-Proxy <string>] [-ProxyCredential <pscredential>] [<CommonParameters>]

DESCRIPTION

Builds a one-page extraction workbench result with text, Markdown, data, forms, endpoints, and guidance.

EXAMPLES

EXAMPLE 1

Invoke-HtmlPageWorkbench -Url https://example.com

PARAMETERS

-BaseUrl

Base URL used to resolve relative links and assets. Defaults to Url when downloading.

Type: Uri
Parameter Sets: Content, Path
Aliases: None
Possible values:

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

-Content

HTML content to inspect.

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

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

-IncludeExternalLinkedScripts

Allows linked-script endpoint inspection to download cross-origin scripts.

Type: SwitchParameter
Parameter Sets: Content, Url, Path
Aliases: None
Possible values:

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

-IncludeLinkedScripts

Downloads same-origin linked JavaScript files and inspects them for endpoints.

Type: SwitchParameter
Parameter Sets: Content, Url, Path
Aliases: None
Possible values:

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

-NoHtml

Omits the original HTML from the workbench result.

Type: SwitchParameter
Parameter Sets: Content, Url, Path
Aliases: None
Possible values:

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

-NoStaticRenderedComparison

Skips static-vs-rendered comparison when a rendered snapshot is supplied.

Type: SwitchParameter
Parameter Sets: Content, Url, Path
Aliases: None
Possible values:

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

-Path

Path to a local HTML file to inspect.

Type: String
Parameter Sets: Path
Aliases: File
Possible values:

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

-Proxy

Proxy server address used when downloading by URL or inspecting linked scripts.

Type: String
Parameter Sets: Content, Url, Path
Aliases: None
Possible values:

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

-ProxyCredential

Credentials used with the proxy server.

Type: PSCredential
Parameter Sets: Content, Url, Path
Aliases: None
Possible values:

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

-RenderedSnapshot

Rendered snapshot from Invoke-HtmlRendering -Snapshot used to enrich the workbench.

Type: HtmlRenderedPageSnapshot
Parameter Sets: Content, Url, Path
Aliases: None
Possible values:

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

-Url

URL of the page to download and inspect.

Type: Uri
Parameter Sets: Url
Aliases: Uri
Possible values:

Required: True
Position: 0
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

  • System.String

OUTPUTS

  • HtmlTinkerX.HtmlPageWorkbenchResult
  • None