#snapshot #terminal #svg

app term-transcript-cli

CLI wrapper for term-transcript

1 unstable release

0.1.0 Jun 1, 2021

#11 in #snapshot

MIT/Apache

150KB
3K SLoC

term-transcript CLI

Build Status License: MIT OR Apache-2.0 rust 1.45.0+ required

This crate provides command-line interface for term-transcript. It allows capturing terminal output to SVG and testing the captured snapshots.

Usage

  • The capture subcommand captures output from stdin, renders it to SVG and outputs SVG to stdout.
  • The exec subcommand executes one or more commands in the shell, captures their outputs, renders to an SVG image and outputs it to stdout.
  • The test subcommand allows testing snapshots from the command line.

Launch the CLI with the --help option for more details about arguments for each subcommand.

Examples

This example creates a snapshot of the rainbow example and then tests it.

Testing rainbow example

The snapshot itself is tested, too! It also shows that SVG output by the program is editable; in the snapshot, this is used to highlight command-line args and to change color of comments in the user inputs.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in term-transcript by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~2–2.7MB
~46K SLoC