asciinema.org/app/views/docs/getting-started.html.slim

42 lines
1.1 KiB
Plaintext
Raw Normal View History

2013-11-18 17:52:34 +00:00
- content_for(:title, 'Getting started')
2013-09-23 19:05:33 +00:00
markdown:
# Getting started
## 1. Install the recorder
2013-09-23 19:05:33 +00:00
2013-11-25 21:07:58 +00:00
The latest stable version of asciinema can always be installed or updated
2013-12-07 15:32:00 +00:00
to via [pip](http://www.pip-installer.org/en/latest/index.html):
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-11-25 21:07:58 +00:00
See [installation docs](#{docs_path(:installation)}) for more installation
methods (Ubuntu, Fedora, Arch Linux, Gentoo).
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
2013-10-14 14:18:51 +00:00
## 3. Create your profile (optional)
2013-09-23 19:05:33 +00:00
2013-11-25 21:07:58 +00:00
If you want your recordings to be assigned to your asciinema profile run the
following command:
2013-09-23 19:05:33 +00:00
$ asciinema auth
2013-11-25 21:07:58 +00:00
If you skip this step now, you can always run the 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-11-25 21:07:58 +00:00
NOTE: To be able to edit/delete your recordings you have to assign them to
your profile.
2013-10-14 14:05:29 +00:00
Btw, see <a href="/~sickill">sickill's profile</a>.