Recording Tips

Creating Your Own Recordings

Great Docs makes it easy to record, edit, and embed terminal sessions in your documentation.

Recording

# Start recording
great-docs termshow record demos/my-demo.termshow

# Perform your CLI actions...
# Press Ctrl+D or type 'exit' to stop

Editing with Scripts

Create a .termshow.yml file alongside your recording to add chapters, annotations, and timing adjustments:

source: demos/my-demo.termshow

settings:
  idle_time_limit: 2.0
  window_chrome: colorful

chapters:
  - at: 0.0
    label: Introduction
  - at: 10.0
    label: Main Feature

annotations:
  - at: 2.0
    duration: 3.0
    text: This step installs dependencies
    position: top-right
    style: callout

cuts:
  - from: 5.0
    to: 8.0
    type: ellipsis

Rendering

# Render SVG frames
great-docs termshow render demos/my-demo.termshow

Embedding

Use the termshow shortcode in your .qmd files:

Importing Existing Recordings

Already have recordings from asciinema or VHS?

# Import from asciinema
great-docs termshow import-cast recording.cast demos/my-demo

# Import from VHS tape
great-docs termshow import-tape demo.tape demos/my-demo