avt

Crates.ioavt
lib.rsavt
version0.14.0
sourcesrc
created_at2024-01-28 17:34:55.077816
updated_at2024-10-14 14:37:43.019048
descriptionasciinema virtual terminal
homepage
repositoryhttps://github.com/asciinema/avt
max_upload_size
id1117762
size4,400,688
Marcin Kulik (ku1ik)

documentation

README

avt - asciinema virtual terminal

avt is asciinema's implementation of virtual terminal emulator written in Rust.

It is used by asciinema CLI, asciinema player, asciinema server and asciinema gif generator.

This implementation covers only parsing and virtual buffer related aspects of a terminal emulator as it's all asciinema needs.

avt consists of:

  • parser for ANSI-compatible video terminal based on excellent state diagram by Paul Williams,
  • virtual screen buffers (primary/alternate) in a form of character grid with additional color/styling attributes,
  • API for feeding text into the parser and for querying virtual screen buffer and cursor position.

Following aspects of terminal emulation are not in scope of this project:

  • input handling,
  • rendering.

While avt is small and focused, a full-fledged terminal emulator could potentially be built on top of it.

avt doesn't try to 100% replicate any specific terminal variant like VT102 or VT520, instead it implements most control sequences supported by modern terminal emulators like xterm, Gnome Terminal, WezTerm, Alacritty, iTerm, mosh etc.

License

© 2019 Marcin Kulik.

All code is licensed under the Apache License, Version 2.0. See LICENSE file for details.

Commit count: 327

cargo fmt