Package: asciinema2
asciinemaTerminal session recorder and the best companion ofasciinema.org.Quick introasciinema lets you easily record terminal sessions and replay
them in a terminal as well as in a web browser.Install latest version (other installation options):sudo pip3 install asciinemaRecord your first session:asciinema rec first.castNow replay it with double speed:asciinema play -s 2 first.castOr with normal speed but with idle time limited to 2 seconds:asciinema play -i 2 first.castYou can pass-i 2toasciinema recas well, to set it permanently on a
recording. Idle time limiting makes the recordings much more interesting to
watch. Try it.If you want to watch and share it on the web, upload it:asciinema upload first.castThe above uploads it toasciinema.org, which is a
defaultasciinema-serverinstance, and prints a secret link you can use to watch your recording in a web
browser.You can record and upload in one step by omitting the filename:asciinema recYou'll be asked to confirm the upload when the recording is done. Nothing is
sent anywhere without your consent.These are the basics, but there's much more you can do. The following sections
cover installation, usage and hosting of the recordings in more detail.InstallationPython packageasciinema is available onPyPIand can
be installed with pip (Python 3 with setuptools required):sudo pip3 install asciinemaThis is the recommended way of installation, which gives you the latest released
version.Native packagesasciinema is included in repositories of most popular package managers on Mac OS
X, Linux and FreeBSD. Look for package namedasciinema. See thelist of available packages.Running latest version from source code checkoutIf you can't use Python package or native package for your OS is outdated you
can clone the repo and run asciinema straight from the checkout.Clone the repo:git clone https://github.com/asciinema/asciinema.git
cd asciinemaIf you want latest stable version:git checkout masterIf you want current development version:git checkout developThen run it with:python3 -m asciinema --versionDocker imageasciinema Docker image is based on Ubuntu 18.04 and has the latest version of
asciinema recorder pre-installed.docker pull asciinema/asciinemaWhen running it don't forget to allocate a pseudo-TTY (-t), keep STDIN open
(-i) and mount config directory volume (-v):docker run --rm -ti -v "$HOME/.config/asciinema":/root/.config/asciinema asciinema/asciinema recContainer's entrypoint is set to/usr/local/bin/asciinemaso you can run the
container with any arguments you would normally pass toasciinemabinary (see
Usage section for commands and options).There's not much software installed in this image though. In most cases you may
want to install extra programs before recording. One option is to derive new
image from this one (start your custom Dockerfile withFROM asciinema/asciinema). Another option is to start the container with/bin/bashas the entrypoint, install extra packages and manually startasciinema rec:docker run --rm -ti -v "$HOME/.config/asciinema":/root/.config/asciinema --entrypoint=/bin/bash asciinema/asciinema
root@6689517d99a1:~# apt-get install foobar
root@6689517d99a1:~# asciinema recUsageasciinema is composed of multiple commands, similar togit,apt-getorbrew.When you runasciinemawith no arguments help message is displayed, listing
all available commands with their options.rec [filename]Record terminal session.By runningasciinema rec [filename]you start a new recording session. The
command (process) that is recorded can be specified with-coption (see
below), and defaults to$SHELLwhich is what you want in most cases.You can temporarily pause the capture of your terminal by pressingCtrl+\.  This is useful when you want to execute some commands during
the recording session that should not be captured (e.g. pasting secrets). Resume
by pressingCtrl+\again. When pausing desktop notification is
displayed so you're sure the sensitive output won't be captured in the
recording.Recording finishes when you exit the shell (hitCtrl+Dor typeexit). If the recorded process is not a shell then recording finishes when
the process exits.If thefilenameargument is omitted then (after asking for confirmation) the
resulting asciicast is uploaded toasciinema-server(by default to
asciinema.org), where it can be watched and shared.If thefilenameargument is given then the resulting recording (calledasciicast) is saved to a local file. It can later be
replayed withasciinema play <filename>and/or uploaded to asciinema server
withasciinema upload <filename>.ASCIINEMA_REC=1is added to recorded process environment variables. This
can be used by your shell's config file (.bashrc,.zshrc) to alter the
prompt or play a sound when the shell is being recorded.Available options:--stdin- Enable stdin (keyboard) recording (see below)--append- Append to existing recording--raw- Save raw STDOUT output, without timing information or other metadata--overwrite- Overwrite the recording if it already exists-c, --command=<command>- Specify command to record, defaults to $SHELL-e, --env=<var-names>- List of environment variables to capture, defaults
toSHELL,TERM-t, --title=<title>- Specify the title of the asciicast-i, --idle-time-limit=<sec>- Limit recorded terminal inactivity to max<sec>seconds-y, --yes- Answer "yes" to all prompts (e.g. upload confirmation)-q, --quiet- Be quiet, suppress all notices/warnings (implies -y)Stdin recording allows for capturing of all characters typed in by the user in
the currently recorded shell. This may be used by a player (e.g.asciinema-player) to display
pressed keys. Because it's basically a key-logging (scoped to a single shell
instance), it's disabled by default, and has to be explicitly enabled via--stdinoption.play <filename>Replay recorded asciicast in a terminal.This command replays given asciicast (as recorded byreccommand) directly in
your terminal.Following keyboard shortcuts are available by default:Space- toggle pause,.- step through a recording a frame at a time (when paused),Ctrl+C- exit.See "Configuration file" section for information on how to customize the
keyboard shortcuts.Playing from a local file:asciinema play /path/to/asciicast.castPlaying from HTTP(S) URL:asciinema play https://asciinema.org/a/22124.cast
asciinema play http://example.com/demo.castPlaying from asciicast page URL (requires<link rel="alternate" type="application/x-asciicast" href="/my/ascii.cast">in page's HTML):asciinema play https://asciinema.org/a/22124
asciinema play http://example.com/blog/post.htmlPlaying from stdin:cat /path/to/asciicast.cast | asciinema play -
ssh user@host cat asciicast.cast | asciinema play -Playing from IPFS:asciinema play dweb:/ipfs/QmNe7FsYaHc9SaDEAEXbaagAzNw9cH7YbzN4xV7jV1MCzK/ascii.castAvailable options:-i, --idle-time-limit=<sec>- Limit replayed terminal inactivity to max<sec>seconds-s, --speed=<factor>- Playback speed (can be fractional)For the best playback experience it is recommended to runasciinema playin
a terminal of dimensions not smaller than the one used for recording, as
there's no "transcoding" of control sequences for new terminal size.cat <filename>Print full output of recorded asciicast to a terminal.Whileasciinema play <filename>replays the recorded session using timing
information saved in the asciicast,asciinema cat <filename>dumps the full
output (including all escape sequences) to a terminal immediately.asciinema cat existing.cast >output.txtgives the same result as recording viaasciinema rec --raw output.txt.upload <filename>Upload recorded asciicast to asciinema.org site.This command uploads given asciicast (recorded byreccommand) to
asciinema.org, where it can be watched and shared.asciinema rec demo.cast+asciinema play demo.cast+asciinema upload demo.castis a nice combo if you want to review an asciicast before
publishing it on asciinema.org.authLink your install ID with your asciinema.org user account.If you want to manage your recordings (change title/theme, delete) at
asciinema.org you need to link your "install ID" with asciinema.org user
account.This command displays the URL to open in a web browser to do that. You may be
asked to log in first.Install ID is a random ID (UUID
v4) generated
locally when you run asciinema for the first time, and saved at$HOME/.config/asciinema/install-id. Its purpose is to connect local machine
with uploaded recordings, so they can later be associated with asciinema.org
account. This way we decouple uploading from account creation, allowing them to
happen in any order.A new install ID is generated on each machine and system user account you use
asciinema on, so in order to keep all recordings under a single asciinema.org
account you need to runasciinema authon all of those machines.asciinema versions prior to 2.0 confusingly referred to install ID as "API
token".Hosting the recordings on the webAs mentioned in theUsage > recsection above, if thefilenameargument toasciinema recis omitted then the recorded asciicast is uploaded toasciinema.org. You can watch it there and share it via
secret URL.If you prefer to host the recordings yourself, you can do so by either:recording to a file (asciinema rec demo.cast), and usingasciinema's
standalone web
playerin your HTML page, orsetting up your ownasciinema-serverinstance,
andsetting API URL
accordingly.Configuration fileYou can configure asciinema by creating config file at$HOME/.config/asciinema/config.Configuration is split into sections ([api],[record],[play]). Here's a
list of all available options for each section:[api]; API server URL, default: https://asciinema.org; If you run your own instance of asciinema-server then set its address here; It can also be overriden by setting ASCIINEMA_API_URL environment variableurl=https://asciinema.example.com[record]; Command to record, default: $SHELLcommand=/bin/bash -l; Enable stdin (keyboard) recording, default: nostdin=yes; List of environment variables to capture, default: SHELL,TERMenv=SHELL,TERM,USER; Limit recorded terminal inactivity to max n seconds, default: offidle_time_limit=2; Answer "yes" to all interactive prompts, default: noyes=true; Be quiet, suppress all notices/warnings, default: noquiet=true; Define hotkey for pausing recording (suspending capture of output),; default: C-\ (control + backslash)pause_key=C-p; Define hotkey prefix key - when defined other recording hotkeys must; be preceeded by it, default: no prefixprefix_key=C-a[play]; Playback speed (can be fractional), default: 1speed=2; Limit replayed terminal inactivity to max n seconds, default: offidle_time_limit=1; Define hotkey for pausing/resuming playback,; default: spacepause_key=p; Define hotkey for stepping through playback, a frame at a time,; default: .step_key=][notifications]; Desktop notifications are displayed on certain occasions, e.g. when; pausing/resuming the capture of terminal with C-\ keyboard shortcut.; Should desktop notifications be enabled, default: yesenabled=no; Custom notification command; asciinema automatically detects available desktop notification system; (notify-send on GNU/Linux, osacript/terminal-notifier on macOS). Custom; command can be used if needed.; When invoked, environment variable $TEXT contains notification text, while; $ICON_PATH contains path to the asciinema logo image.command=tmux display-message "$TEXT"A very minimal config file could look like that:[record]idle_time_limit=2Config directory location can be changed by setting$ASCIINEMA_CONFIG_HOMEenvironment variable.If$XDG_CONFIG_HOMEis set on Linux then asciinema uses$XDG_CONFIG_HOME/asciinemainstead of$HOME/.config/asciinema.asciinema versions prior to 1.1 used$HOME/.asciinema. If you have it
there you shouldmv $HOME/.asciinema $HOME/.config/asciinema.ContributingIf you want to contribute to this project check outContributingpage.AuthorsDeveloped with passion byMarcin Kulikand great open
sourcecontributors.LicenseCopyright © 2011–2021 Marcin Kulik.All code is licensed under the GPL, v3 or later. See LICENSE file for details.