Skip to main content

great-docs termshow

Terminal recording and playback for CLI/TUI documentation.

great-docs termshow COMMAND [ARGS]...

Record terminal sessions, edit them with YAML scripts, and render them as SVG frame sequences for the termshow player.

Full --help output
Usage: great-docs termshow [OPTIONS] COMMAND [ARGS]...

  Terminal recording and playback for CLI/TUI documentation.

  Record terminal sessions, edit them with YAML scripts, and render them as
  SVG frame sequences for the termshow player.

Options:
  --help  Show this message and exit.

Commands:
  assets       Copy the web player into a directory, for pages built...
  check        Check that recordings made from steps still match what the...
  edit         Open the Termshow Editor for a .termshow recording.
  export       Export a recording as an animated SVG, a GIF or video, an...
  import-cast  Import an asciicast (.cast) file to .termshow format.
  import-tape  Convert a VHS .tape file to a .termshow.yml script with...
  play         Play a recording directly in the terminal.
  record       Record a terminal session to a .termshow file.
  render       Render a .termshow recording into SVG frames.
  snap         Take a screenshot of one moment in a recording.
  transcript   Write the text of a recording, or captions for it.
  validate     Check recordings and their scripts for mistakes.

Commands