Uses new Rust 2021
|0.2.0||Jun 12, 2022|
|0.2.0-beta.1||Jan 6, 2022|
|0.1.0||Jun 1, 2021|
#99 in Testing
This crate provides command-line interface for
term-transcript. It allows capturing
terminal output to SVG and testing the captured snapshots.
cargo install --locked term-transcript-cli # This will install `term-transcript` executable, which can be checked # as follows: term-transcript --help
--features portable-pty in the installation command
to enable the pseudo-terminal (PTY) support (note that PTY capturing still needs
to be explicitly switched on when running
Without this feature, console app output is captured via OS pipes,
which means that programs dependent on
or getting term size can produce different output than if launched in an actual shell
(no coloring, no line wrapping etc.).
capturesubcommand captures output from stdin, renders it to SVG and outputs SVG to stdout.
execsubcommand executes one or more commands in the shell, captures their outputs, renders to an SVG image and outputs it to stdout.
testsubcommand allows testing snapshots from the command line.
Launch the CLI with the
--help option for more details about arguments
for each subcommand.
This example creates a snapshot of the
rainbow script and then tests it.
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.
test command can compare colors as well:
Another snapshot created by capturing help output from a pseudo-terminal
Using PTY enables coloring output by default and formatting dependent on the terminal size.
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.