asciinema

Record and replay terminal sessions

TLDR

Record terminal session

$ asciinema rec [recording.cast]

Play recorded session

$ asciinema play [recording.cast]

Upload to asciinema.org

$ asciinema upload [recording.cast]

Record with title

$ asciinema rec -t "[My recording]" [recording.cast]

Record with idle time limit

$ asciinema rec --idle-time-limit=[2] [recording.cast]

SYNOPSIS

asciinema rec|play|upload|auth [options] [file]

asciinema records and replays terminal sessions. It captures terminal output with timing information, creating lightweight recordings that can be shared or embedded on websites.
Unlike video screen recording, asciinema recordings are text-based, allowing copy-paste from playback and producing small file sizes.

PARAMETERS

rec [file]

Record terminal session

play file

Playback recorded session

upload file

Upload recording to asciinema.org

auth

Authenticate with asciinema.org

-t title, --title title

Recording title

-c cmd, --command cmd

Command to record (default: $SHELL)

--idle-time-limit sec

Maximum idle time between frames

-i sec

Shorthand for --idle-time-limit

-s speed, --speed speed

Playback speed multiplier

--cols n / --rows n

Override terminal dimensions

CONFIGURATION

~/.config/asciinema/config

User configuration file for default recording settings, API URL, and authentication token.

CAVEATS

Recordings capture exactly what appears in terminal, including sensitive data. Review before uploading. Playback requires terminal with same capabilities as recording.

HISTORY

asciinema was created by Marcin Kulik, with the first version released around 2011. It has become the standard tool for terminal recording and sharing.