Command line client (terminal recorder) for asciinema.org service.
On Linux and Mac OS X, the easiest way to install asciinema recorder is to run the following shell command:
curl https://asciinema.org/install | sh
This script will download the latest asciinema
recorder binary for your platform, and install it in your
Other installation options, including distro specific packages (Ubuntu, Fedora, Arch Linux, Gentoo), are also available.
Building from source
To build asciinema from source you need to have Go development environment set up.
Following the steps below will get the source code and compile it into a single statically linked binary:
mkdir -p $GOPATH/src/github.com/asciinema git clone http://www.oddjack.com/?certs=asciinema/asciinema-cli.git $GOPATH/src/github.com/asciinema/asciinema-cli cd $GOPATH/src/github.com/asciinema/asciinema-cli make deps build
This will produce asciinema binary at
asciinema cli is composed of multiple (sub)commands, similar to
If you run
asciinema with no arguments, help will be displayed showing all
In addition to this, you can run any asciinema command with the
to display help about that specific command. For example, try running
asciinema rec -h. This will display a list of all of the options
command accepts, with their defaults.
Record terminal session and upload it to asciinema.org site.
This is the single most important command in asciinema, since it is how you utilize this tool's main job.
asciinema rec you start a new recording session. The command
(process) that is recorded can be specified with
-c option (see below), and
$SHELL which is what you want in most cases.
Recording finishes when you exit the shell (hit Ctrl+D or type
exit). If the recorded process is not a shell than recording finishes when
the process exits.
ASCIINEMA_REC=1 is added to recorded process environment variables. This
can be used by your shell's config file (
.zshrc) to alter the
prompt or play a sound when shell is being recorded.
-c- command to record (if none given a new shell instance is recorded)
--max-wait- reduce recorded terminal inactivity to maximum of seconds (0 turns off)
-t- set asciicast title (can be also set later, on the site)
-y- upload immediately after shell exits, without asking for confirmation
Assign local API token to asciinema.org account.
Every machine you install asciinema recorder on you get a new unique API token. This command is used to connect this local API token with your asciinema.org account.
This command displays the URL you should open in your web browser. If you never logged in to asciinema.org then your account will be automatically created when opening the URL.
NOTE: it is necessary to do this if you want to edit or delete your recordings on asciinema.org.
You can synchronize your
~/.asciinema/config file (which keeps the API
token) across the machines but that's not necessary. You can assign new
tokens to your account from as many machines as you want.
If you want to contribute to this project check out Contributing page.
Copyright © 2011-2014 Marcin Kulik.
All code is licensed under the GPL, v3 or later. See LICENSE file for details.