Skip to content

Asciinema client written in Rust

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

LegNeato/asciinema-rs

Repository files navigation

Build Status

A reimplementation of the asciinema command line program written in Rust.

Installation

Prebuilt asciinema binaries can be downloaded from GitHub releases. There are no dependencies and the binary can be run directly once downloaded.

(asciinema is not available on crates.io due to rust-lang/cargo#1565).

Usage

This program intends be a drop-in replacement for the official asciinema python client program. Accordingly, the official documentation serves as documentation for this version as well. If you find behavior differences, please file an issue.

# Record terminal and upload it to asciinema.org:
asciinema rec

# Record terminal to local file:
asciinema rec demo.cast

# Record terminal and upload it to asciinema.org, specifying title:
asciinema rec -t "My git tutorial"

# Record terminal to local file, limiting idle time to max 2.5 sec:
asciinema rec -i 2.5 demo.cast

Example

Below is an example recording where the program records itself.

Feature Parity

We are not yet at 100% parity with the official binary. This project welcomes contributors and is a great project for Rust beginners. Please contribute!

Record (asciinema rec)

Auth (asciinema auth)

  • Authenticate via an install-id

Upload (asciinema upload)

  • Upload saved asciicast session

Play (asciinema play)

Cat (asciinema cat)

  • Support for local files
  • Support for remote files

License

asciinema is licensed under either of the following, at your option:

Note that the reference python implementation is licensed under GPLv3. This program is developed without looking at or using any of the code.