Skip to main content

great-docs termshow record

Record a terminal session to a .termshow file.

great-docs termshow record [OPTIONS] [OUTPUT]

Spawns an interactive shell and captures all output with timing. Press Ctrl+D or type exit to stop recording.

With --steps, nothing is typed by hand: the script’s steps: are run in a hidden terminal and the session is saved. OUTPUT defaults to the recording the script belongs to (demo.termshow for demo.termshow.yml), and --cols, --rows, and --shell override the script’s record: settings.

Full --help output
Usage: great-docs termshow record [OPTIONS] [OUTPUT]

  Record a terminal session to a .termshow file.

  Spawns an interactive shell and captures all output with timing. Press
  Ctrl+D or type 'exit' to stop recording.

  With --steps, nothing is typed by hand: the script's `steps:` are run in a
  hidden terminal and the session is saved. OUTPUT defaults to the recording
  the script belongs to (demo.termshow for demo.termshow.yml), and --cols,
  --rows, and --shell override the script's `record:` settings.

  Examples:   great-docs termshow record docs/assets/install.termshow   great-
  docs termshow record --steps docs/assets/install.termshow.yml

Options:
  --steps FILE     Run the steps in this .termshow.yml script instead of
                   recording live
  --cols INTEGER   Terminal width in columns
  --rows INTEGER   Terminal height in rows
  --shell TEXT     Shell to spawn (default: $SHELL)
  --capture-input  Also capture keyboard input events
  --help           Show this message and exit.

Arguments

OUTPUT: PATH
Optional.

Options

--steps: FILE
Run the steps in this .termshow.yml script instead of recording live
--cols: INTEGER
Terminal width in columns
--rows: INTEGER
Terminal height in rows
--shell: TEXT
Shell to spawn (default: $SHELL)
--capture-input
Also capture keyboard input events

Examples

  great-docs termshow record docs/assets/install.termshow
  great-docs termshow record --steps docs/assets/install.termshow.yml