2013-09-23 19:05:33 +00:00
|
|
|
markdown:
|
|
|
|
|
|
|
|
|
|
# Getting started
|
|
|
|
|
|
|
|
|
|
## 1. Install recorder
|
|
|
|
|
|
2013-10-06 11:50:17 +00:00
|
|
|
The latest __stable version__ of asciinema can always be installed or updated
|
|
|
|
|
to via [pip](http://www.pip-installer.org/en/latest/index.html) (prefered) or
|
|
|
|
|
easy\_install:
|
2013-09-23 19:05:33 +00:00
|
|
|
|
2013-10-06 11:50:17 +00:00
|
|
|
sudo pip install --upgrade asciinema
|
2013-09-23 19:05:33 +00:00
|
|
|
|
2013-10-06 11:50:17 +00:00
|
|
|
Alternatively:
|
2013-09-23 19:05:33 +00:00
|
|
|
|
2013-10-06 11:50:17 +00:00
|
|
|
sudo easy_install asciinema
|
2013-09-23 19:05:33 +00:00
|
|
|
|
2013-10-06 11:50:17 +00:00
|
|
|
Or, you can install the __development version__ directly from GitHub:
|
2013-09-23 19:05:33 +00:00
|
|
|
|
2013-10-06 11:50:17 +00:00
|
|
|
sudo pip install --upgrade https://github.com/sickill/asciinema/tarball/master
|
2013-09-23 19:05:33 +00:00
|
|
|
|
2013-10-06 11:50:17 +00:00
|
|
|
Arch Linux users can install the
|
|
|
|
|
[AUR](https://aur.archlinux.org/packages/asciinema/) package:
|
2013-09-23 19:05:33 +00:00
|
|
|
|
2013-10-06 11:50:17 +00:00
|
|
|
yaourt -S asciinema
|
2013-09-23 19:05:33 +00:00
|
|
|
|
|
|
|
|
## 2. Record
|
|
|
|
|
|
|
|
|
|
Open your terminal and run following command:
|
|
|
|
|
|
2013-10-06 11:50:17 +00:00
|
|
|
$ asciinema rec
|
2013-09-23 19:05:33 +00:00
|
|
|
|
|
|
|
|
New shell instance will be opened and everything you'll do in it will be
|
|
|
|
|
recorded. When you're ready to upload simply exit the shell with `exit`
|
2013-10-14 13:50:02 +00:00
|
|
|
command or hit `<C-d>`.
|
2013-09-23 19:05:33 +00:00
|
|
|
|
|
|
|
|
## 3. Create profile (optional)
|
|
|
|
|
|
|
|
|
|
If you want your recordings to be assigned to your asciinema profile and to be
|
|
|
|
|
able to edit/delete them run this and follow instructions:
|
|
|
|
|
|
|
|
|
|
$ asciinema auth
|
|
|
|
|
|
|
|
|
|
If you skip this step now, you can always run above command later and all
|
|
|
|
|
previously recorded asciicasts will get automatically assigned to your new
|
|
|
|
|
profile.
|
|
|
|
|
|
|
|
|
|
Btw, see [my profile](/~sickill).
|
|
|
|
|
|
|
|
|
|
## Advanced options
|
|
|
|
|
|
|
|
|
|
The recorder supports several command-line options. See
|
|
|
|
|
[here](#{docs_path(:options)}) for details.
|
