asciinema.org/app/views/docs/record.html.slim

48 lines
1.3 KiB
Plaintext
Raw Normal View History

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
2013-10-14 14:05:29 +00:00
Go to your terminal and run the following command:
2013-09-23 19:05:33 +00:00
2013-10-06 11:50:17 +00:00
$ asciinema rec
2013-09-23 19:05:33 +00:00
2013-10-14 14:05:29 +00:00
New shell will be spawned and everything you do in it will get recorded.
When you're finished simply exit the shell either by typing `exit`
or hitting `<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
2013-10-14 14:05:29 +00:00
able to edit/delete them run this and follow the instructions:
2013-09-23 19:05:33 +00:00
$ asciinema auth
If you skip this step now, you can always run above command later and all
2013-10-14 14:05:29 +00:00
previously recorded asciicasts will automatically get assigned to your new
2013-09-23 19:05:33 +00:00
profile.
2013-10-14 14:05:29 +00:00
Btw, see <a href="/~sickill">sickill's profile</a>.