Cmdlet

Start-ConsoleDemo

Module: ConsoleMonster
Inputs: None
Outputs: System.IO.FileInfo

Presents a scripted demo one command at a time in a real shell.

Syntax

Start-ConsoleDemo
[-Height <Int32>]
[-IdleLimit <Double>]
[-Path] <String>
[-Record <String>]
[-Redact <String[]>]
[-Seed <Int32>]
[-Shell <String>]
[-StepTimeoutSeconds <Int32>]
[-Width <Int32>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

Enter types and runs; Space types without running; b moves back without undoing side effects; s skips; q quits. The terminal title shows the step counter. Optional -Record saves the same child output as asciicast; without it temporary capture files are removed on exit. Stop or cancellation terminates only the owned child and restores the title.

Examples

Example 1

Start-ConsoleDemo -Path ./demo.ps1 -Record ./talk.cast

Present and record

Parameters

-Height Int32 optional: Terminal height in cells.
-IdleLimit Double optional: Longest recorded idle gap in seconds; zero preserves actual timing.
-Path String requiredposition: 0: Plain PowerShell demo file with optional # demo: directives.
-Record String optional: Optional asciicast recording path.
-Redact String[] optional: Output patterns redacted before recording.
-Seed Int32 optional: Seed for repeatable character timing.
-Shell String optional: Child PowerShell executable. Defaults to the current PowerShell.
-StepTimeoutSeconds Int32 optional: Maximum wait for a semantic prompt or output pattern.
-Width Int32 optional: Terminal width in cells.

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.