Cmdlet

Export-ConsoleRecording

Module ConsoleMonster

Inputs

None

Outputs

System.String System.IO.FileInfo

Exports a dashboard recording to an HTML player, an animated SVG or asciicast.

Syntax

Export-ConsoleRecording [-Dashboard] <IWidget> [[-Destination] <String>] [-Format <Html|Svg|Asciicast|PlayerData>] [-FramesPerSecond <Double>] [-Height <Int32>] [-PassThru] [-Path] <String> [-Speed <Double>] [-Theme <Auto|Dark|Light>] [-Title <String>] [-Width <Int32>] [-WindowChrome] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Exports a dashboard recording to an HTML player, an animated SVG or asciicast.

Recordings (written by Start-ConsoleDashboard -RecordPath) hold updates, not pictures, so they are played into the same dashboard definition at a fixed size and frame rate. Html writes a self-contained page with a small player (play/pause, speed, scrubbing; add #t=30000 to the address to open at 30 seconds). Svg writes an animated image with CSS keyframes and no script, for READMEs. Asciicast writes asciicast v3 for asciinema and other players (output events only). Identical frames are merged; a long recording is sampled less often.

Examples

Authored help example

EXAMPLE 1

Export-ConsoleRecording -Dashboard 'Value' -Path 'C:\Path'

Parameters

-Dashboard IWidget requiredposition: 0: The dashboard (or widget tree) the recording was made with.
-Destination String optionalposition: 2aliases: OutFile: The file to write. Without it the document goes to the pipeline.
-Format String optional: Html, Svg, Asciicast or PlayerData (default: from the -Destination extension, .json for PlayerData, else Html). PlayerData is the JSON the native player script plays, for sites that include the script once (see ConsoleExporter.PlayerScript).; Possible values: Html, Svg, Asciicast, PlayerData
-FramesPerSecond Double optional: Frames per second sampled from the recording (default 10).
-Height Int32 optional: Screen height in cells (default 30).
-PassThru SwitchParameter optional: With -Destination, also writes the file to the pipeline.
-Path String requiredposition: 1: The recording (.jsonl).
-Speed Double optional: Playback speed baked into the export (default 1).
-Theme ExportTheme optional: Dark (default) or Light.; Possible values: Auto, Dark, Light
-Title String optional: The title (page title, title bar, asciicast title).
-Width Int32 optional: Screen width in cells (default 100).
-WindowChrome SwitchParameter optional: Draws a window frame with a title bar (Html and Svg).

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.