asciinema /asciinema

Terminal session recorder, streamer and player 📹

★ 17,966⑂ 1,049👁 272⑃ 255● 367▤ 26
RustGPL-3.0Created 2011-11-21asciinema.org
下载:v3.2.1v3.2.1 ↓3.2.12026-06-16
+5
日增长
17,966
stars
1,049
forks
272
watchers
255
prs
367
issues
26
releases

README

asciinema




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

Unlike typical _screen_ recording software, which records visual output of a
screen into a heavyweight video files (.mp4, .mov), asciinema CLI runs
_inside a terminal_, capturing terminal session output into a lightweight
recording files in the
asciicast format (.cast),
or streaming it live to viewers in real-time.

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. Live streams allow
viewers to watch terminal sessions as they happen.

asciinema runs on GNU/Linux, macOS and FreeBSD.



Notable features:

- recording of terminal sessions to a file, with optional keyboard input
  capture and configurable
  environment variable capture,
- replaying of recordings inside a terminal, with adjustable speed, looping,
  idle time limiting, step-by-step navigation,
  pause-on-markers, and
  optional terminal auto-resize,
- local and remote live
  streaming
  of terminal sessions to multiple viewers in real-time, including a built-in
  HTTP server with an embedded web player for LAN/localhost viewing,
- combined sessions: record to a file while streaming locally and remotely at
  the same time,
- lightweight asciicast recording
  format, with native reading
  and writing of zstd-compressed (.zst) recordings (8% of the original size
  on average),
- conversion from asciicast v1/v2/v3 to asciicast v2/v3, raw terminal output,
  or plain text,
- concatenation of multiple recordings into one, with timing adjusted
  automatically,
- mid-session controls: pause/resume capture and add markers on the fly via
  customizable key bindings,
- session metadata capture, including terminal size, terminal theme, command,
  and title,
- configuration file support for defaults such as recording command, capture
  options, playback speed, idle time limit, notifications, and key bindings,
- headless mode, configurable terminal window size, and exit-status propagation
  for scripted and CI-friendly recording and streaming,
- support for stdin/stdout in conversion and playback from local files, stdin,
  or HTTP(S) URLs,
- integration with asciinema
  server, e.g.
  asciinema.org, for uploads, hosting, remote live
  streaming, self-hosted servers, visibility control, descriptions, and
  synchronized audio URLs.

To record a session run this command in your shell:

sh
asciinema rec demo.cast


To stream a session via built-in HTTP server run:

sh
asciinema stream -l


To stream a session via a relay (asciinema server) run:

sh
asciinema stream -r


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

 Building

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

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


This 

Top issues

Latest release

v3.2.1 v3.2.1 2026-06-16
This is a small release, mostly improving error handling and formatting.

 Improved error reporting for server API failures - server-provided error messages are now surfaced, with actionable guidance (e.g. running asciinema auth)
 Built release binaries on Ubuntu 22.04 for broader compatibility with older Linux systems (742)
 Upgraded the virtual terminal (avt) to the latest version
 Upgraded dependencies, including security fixes

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON