asciinema.org/app/views/docs/record.html.erb
2013-09-22 14:07:42 +02:00

59 lines
1.2 KiB
Plaintext

<%= markdown do %>
# Getting started
## 1. Install recorder
### Linux
To install/update asciinema recorder, open a terminal and run following
command:
$ curl -sL get.asciinema.org | bash
### OSX (via Homebrew)
Install with:
$ brew install https://raw.github.com/gist/3875486/asciiio.rb --HEAD
Later update with:
$ brew upgrade asciinema
### OSX (no Homebrew)
If you don't use Homebrew then install/update with:
$ curl -sL get.asciinema.org | bash
## 2. Record
Open your terminal and run following command:
$ asciinema
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`
command or just hit `<C-d>`.
## 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.
<% end %>