You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Marcin Kulik 755532b1ec Replace vec.rotate_left+truncate with vec.drain(..n) 16 hours ago
.cargo
.github Bump actions/checkout from 3 to 4 1 month ago
assets Use latest web player 5 days ago
doc Link asciicast format docs to latest versions on docs.asciinema.org 1 month ago
src Replace vec.rotate_left+truncate with vec.drain(..n) 16 hours ago
tests Capture terminal color palette 1 week ago
.gitignore Add nix flake for dev shell 6 days ago
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Cargo.lock Capture terminal color palette 1 week ago
Cargo.toml Capture terminal color palette 1 week ago
Dockerfile Update Dockerfile 4 weeks ago
LICENSE
README.md Added note in build section explaining that windows is not supported. 1 week ago
flake.lock Add nix flake for dev shell 6 days ago
flake.nix Add nix flake for dev shell 6 days ago

README.md

asciinema

Build Status license

asciinema (aka asciinema CLI or asciinema recorder) is a command-line tool for recording terminal sessions.

Unlike typical screen recording software, which records visual output of a screen into a heavyweight video files (.mp4, .mov), asciinema recorder runs inside a terminal, capturing terminal session output into a lightweight recording files in the asciicast format (.cast).

The recordings can be replayed in a terminal, embedded on a web page with the asciinema player, or published to an asciinema server, such as asciinema.org, for further sharing.

asciinema CLIdemo

Notable features:

Recording is as easy as running this command in your shell:

asciinema rec demo.cast

Check out the Getting started guide for installation and usage overview.

Building

Building asciinema from source requires the Rust compiler (1.70 or later), and the Cargo package manager. If they are not available via your system package manager then use rustup.

To download the source code, build the asciinema binary, and install it in $HOME/.cargo/bin run:

cargo install --git https://github.com/asciinema/asciinema

Then, ensure $HOME/.cargo/bin is in your shell's $PATH.

Alternatively, you can manually download the source code and build the asciinema binary with:

git clone https://github.com/asciinema/asciinema
cd asciinema
cargo build --release

This produces the binary in release mode (--release) at target/release/asciinema. There are no other build artifacts so you can just copy the binary to a directory in your $PATH.

[!NOTE] Windows is currently not supported. (See #467)

Development

This branch contains the next generation of the asciinema CLI, written in Rust (about the rewrite). It is still in a heavy work-in-progress stage, so if you wish to propose any code changes, please first reach out to the team via forum, Matrix or IRC.

The previous generation of the asciinema CLI, written in Python, can be found in the main branch.

Donations

Sustainability of asciinema development relies on donations and sponsorships.

Please help the software project you use and love. Become a supporter or a corporate sponsor.

asciinema is sponsored by:

Consulting

If you're interested in integration or customization of asciinema to suit your needs, check asciinema consulting services.

License

© 2011 Marcin Kulik.

All code is licensed under the GPL, v3 or later. See LICENSE file for details.