Skip to content

Record/play replays

Available since v0.9

Save keyboard input and timing to a JSON file, then reproduce the exact same operations later for recapture. This is suitable for regular documentation image updates and CI automation.

Run with a destination file path specified for the --replay-save option.

Terminal
# Record an interactive session
console2svg interactive --replay-save demo.json -- bash

All keystrokes and time intervals during execution are saved to demo.json.

Use the replay subcommand to run capture with a saved replay file.

Terminal
console2svg replay demo.json -- bash

console2svg replay demo.json -- bash