term-transcript CLI

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

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

Usage

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

Examples

This example creates a snapshot of the rainbow script 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.

The test command can compare colors as well:

Testing color match

Another snapshot created by capturing help output from a pseudo-terminal (the --pty flag):

Output of <code>test-transcript --help</code>

Using PTY enables coloring output by default and formatting dependent on the terminal size.

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.