great-docs termshow check

Check that recordings made from steps still match what the steps produce.

great-docs termshow check [OPTIONS] SCRIPTS...

Each script’s steps are run again, as record --steps would, and the screen is compared with the committed recording at every marker and at the end. Timing isn’t compared. Give the .termshow.yml scripts, or the .termshow recordings they belong to.

Text that changes from run to run, such as a version number or a temporary path, can be left out with --ignore or the script’s check.ignore list.

Exits with status 1 if any recording has drifted or a step failed. With --update, recordings that have drifted are recorded again instead.

With --json, the results are printed as one JSON object instead, with the same exit status. Progress still goes to stderr.

Full --help output

Usage: great-docs termshow check [OPTIONS] SCRIPTS...

  Check that recordings made from steps still match what the steps produce.

  Each script's steps are run again, as `record --steps` would, and the screen
  is compared with the committed recording at every marker and at the end.
  Timing isn't compared. Give the .termshow.yml scripts, or the .termshow
  recordings they belong to.

  Text that changes from run to run, such as a version number or a temporary
  path, can be left out with --ignore or the script's `check.ignore` list.

  Exits with status 1 if any recording has drifted or a step failed. With
  --update, recordings that have drifted are recorded again instead.

  With --json, the results are printed as one JSON object instead, with the
  same exit status. Progress still goes to stderr.

  Examples:   great-docs termshow check docs/assets/*.termshow.yml   great-
  docs termshow check docs/assets/install.termshow --ignore 'v\d+\.\d+'
  great-docs termshow check docs/assets/*.termshow.yml --json > drift.json

Options:
  --ignore REGEX  Leave text matching this pattern out of the comparison
                  (repeatable)
  --update        Re-record the recordings that have drifted
  --shell TEXT    Run the steps in this shell instead
  --json          Print the results as JSON, for CI and other tools
  --help          Show this message and exit.

Arguments

SCRIPTS: FILE

Required.

Options

--ignore: TEXT

Leave text matching this pattern out of the comparison (repeatable)

--update

Re-record the recordings that have drifted

--shell: TEXT

Run the steps in this shell instead

--json

Print the results as JSON, for CI and other tools

Examples

  great-docs termshow check docs/assets/*.termshow.yml
  great-docs termshow check docs/assets/install.termshow --ignore 'v\d+\.\d+'
  great-docs termshow check docs/assets/*.termshow.yml --json > drift.json