Skip to content
ConsoleMonster
Cmdlet

Start-ConsoleReplay

Module ConsoleMonster
Inputs
None

Replays a recorded dashboard session (JSON lines) into a dashboard.

Syntax

Start-ConsoleReplay [-Dashboard] <IWidget> [-Path] <String> [-Speed <Double>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Description

Replays a recorded dashboard session (JSON lines) into a dashboard.

Recordings are written by Start-ConsoleDashboard -RecordPath. Replays keep the original timing, scaled by -Speed (0 plays as fast as possible). Useful for demos, documentation captures, tests and bug reports.

Examples

Authored help example

EXAMPLE 1

Start-ConsoleReplay -Dashboard 'Value' -Path 'C:\Path'

Parameters

-Dashboard IWidget requiredposition: 0
The dashboard (or any widget tree) whose widget names match the recording.
-Path String requiredposition: 1
The recording file.
-Speed Double optional
Replay speed (default 1).

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.