Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asciinema/agg
asciinema gif generator
https://github.com/asciinema/agg
asciinema gif rust terminal
Last synced: 28 days ago
JSON representation
asciinema gif generator
- Host: GitHub
- URL: https://github.com/asciinema/agg
- Owner: asciinema
- License: apache-2.0
- Created: 2022-07-29T08:05:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-17T10:12:48.000Z (3 months ago)
- Last Synced: 2024-10-01T19:09:44.656Z (about 1 month ago)
- Topics: asciinema, gif, rust, terminal
- Language: Rust
- Homepage:
- Size: 17.4 MB
- Stars: 1,175
- Watchers: 6
- Forks: 43
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# agg - asciinema gif generator
__agg__ is a command-line tool for generating animated GIF files from terminal
session recordings.
It supports conversion from [asciicast
v2](https://github.com/asciinema/asciinema/blob/master/doc/asciicast-v2.md)
files produced by [asciinema recorder](https://github.com/asciinema/asciinema).
It uses Kornel Lesiński's excellent
[gifski](https://github.com/ImageOptim/gifski) library to produce optimized,
high quality GIF output with accurate frame timing.
Example GIF file generated with agg:
Check out the [agg docs](https://docs.asciinema.org/manual/agg/) for
installation and usage overview.
agg is a successor to
[asciicast2gif](https://github.com/asciinema/asciicast2gif).
## Building
Building from source requires [Rust](https://www.rust-lang.org/) compiler
(1.56.0 or later) and [Cargo package manager](https://doc.rust-lang.org/cargo/).
You can install both with [rustup](https://rustup.rs/).
To download source code, build agg binary and install it in `$HOME/.cargo/bin`
run:
```bash
cargo install --git https://github.com/asciinema/agg
```
You need to ensure `$HOME/.cargo/bin` is in your shell's `$PATH`.
Alternatively, you can manually download source code and build agg binary with:
```bash
git clone https://github.com/asciinema/agg
cd agg
cargo build --release
```
This produces an executable file in _release mode_ (`--release`) at
`target/release/agg`. There are no other build artifacts so you can copy the
binary to a directory in your `$PATH`.
### Building with Docker
Alternatively, if you have Docker, Podman or another Docker-compatible tool
installed you can use it to build agg container image. This doesn't require Rust
toolchain installed on your machine.
Build the image with the following command:
```sh
docker build -t agg .
```
Then run agg like this:
```sh
docker run --rm -it -u $(id -u):$(id -g) -v $PWD:/data agg demo.cast demo.gif
```
If you use Podman in root-less mode:
```sh
podman run --rm -it -v $PWD:/data agg demo.cast demo.gif
```
## Consulting
If you're interested in customization of agg or any other asciinema component to
for your corporate needs, check [asciinema consulting
services](https://docs.asciinema.org/consulting/).
## License
© 2022 Marcin Kulik.
All code is licensed under the Apache License, Version 2.0. See LICENSE file for details.