# great-docs termshow snap

Take a screenshot of one moment in a recording.

``` bash
great-docs termshow snap [OPTIONS] SOURCE
```

The screenshot is a still SVG, or a PNG with `--png` or an `-o` name ending in .png, for poster images, social cards, and slides. It uses the companion .termshow.yml script's cuts, speed changes, theme, window chrome, and prompt replacement unless `--no-script` is given, and `--at` is a time on the resulting playback timeline.

With a light/dark theme pair, two files are written (NAME-light and NAME-dark), along with a snippet that picks one by the reader's color scheme.

Full `--help` output

    Usage: great-docs termshow snap [OPTIONS] SOURCE

      Take a screenshot of one moment in a recording.

      The screenshot is a still SVG, or a PNG with --png or an -o name ending in
      .png, for poster images, social cards, and slides. It uses the companion
      .termshow.yml script's cuts, speed changes, theme, window chrome, and prompt
      replacement unless --no-script is given, and --at is a time on the resulting
      playback timeline.

      With a light/dark theme pair, two files are written (NAME-light and NAME-
      dark), along with a <picture> snippet that picks one by the reader's color
      scheme.

      Examples:   great-docs termshow snap demos/install.termshow   great-docs
      termshow snap demos/install.termshow --at 12.5 -o shot.svg   great-docs
      termshow snap demos/install.termshow --chapter Install --png

    Options:
      --at FLOAT         Playback time in seconds
      --chapter TEXT     Take the last screen of the chapter with this label
      --end              Take the last screen (the default)
      -o, --output FILE  Output .svg or .png file (default: the recording's name
                         with -snap.svg)
      --png              Write a PNG (needs rsvg-convert or resvg)
      --scale FLOAT      Pixels per SVG unit in a PNG  [default: 2]
      --annotations      Draw the annotations showing at that moment
      --font-file FILE   Embed this .woff2/.woff/.ttf/.otf font for the terminal
                         text (SVG only)
      --script PATH      Path to .termshow.yml script
      --no-script        Ignore any companion .termshow.yml script
      --help             Show this message and exit.

## Arguments

`SOURCE: PATH`  
Required.

## Options

`--at: FLOAT`  
Playback time in seconds

`--chapter: TEXT`  
Take the last screen of the chapter with this label

`--end`  
Take the last screen (the default)

`-o, --output: FILE`  
Output .svg or .png file (default: the recording's name with -snap.svg)

`--png`  
Write a PNG (needs rsvg-convert or resvg)

`--scale: FLOAT`  
Pixels per SVG unit in a PNG \[default: 2\]

`--annotations`  
Draw the annotations showing at that moment

`--font-file: FILE`  
Embed this .woff2/.woff/.ttf/.otf font for the terminal text (SVG only)

`--script: PATH`  
Path to .termshow.yml script

`--no-script`  
Ignore any companion .termshow.yml script

## Examples

``` bash
  great-docs termshow snap demos/install.termshow
  great-docs termshow snap demos/install.termshow --at 12.5 -o shot.svg
  great-docs termshow snap demos/install.termshow --chapter Install --png
```