Skip to content

Check

txi check validates one or more transcript files against a specific reader format, without touching the index. Use it to confirm that a new export parses cleanly before running txi sync, or to diagnose why a file is being skipped as malformed.

txi check --format otter path/to/transcript.txt

Arguments

  • FILES... — one or more file or directory paths. Directories are expanded recursively; only files the chosen reader recognizes are checked, and others are silently skipped.
  • --format, -f — required. The reader format to validate against (for example, otter).
  • --show-files — also print files that pass. By default, passing files are suppressed and only failures are shown.

Output

On success:

All transcripts passed!

On failure, each problem file is reported in red with the reader's error message:

path/to/bad.txt: error: no turn headers detected

If a file is passed explicitly but isn't a candidate for the chosen reader, it is reported as an error rather than silently skipped. Directory expansion still skips non-candidates silently.

The exit code is 0 if every file parsed cleanly and 1 if any file failed, so txi check is suitable for CI or pre-commit hooks.