Archives/asciinema.org
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update usage docs

Browse Source
This commit is contained in:
Marcin Kulik 2015-03-12 17:06:00 +01:00
parent 3078b85d71
commit 13c114b8fa
1 changed files with 49 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
app/views/docs/usage.html.slim
View File

@ -4,54 +4,78 @@ markdown:
# Usage # Usage
asciinema cli is composed of multiple (sub)commands, similar to `git`, asciinema is composed of multiple commands, similar to `git`, `rails` or
`rails` or `brew`. `brew`.
If you run `asciinema` with no arguments, help will be displayed showing all When you run `asciinema` with no arguments help message is displayed showing
available commands. all available commands with their options.
In addition to this, you can run any asciinema command with the `-h` switch ## `rec [filename]`
to display help about that specific command. For example, try running
`asciinema rec -h`. This will display a list of all of the options `rec`
command accepts, with their defaults.
## `rec` __Record terminal session.__
__Record terminal session and upload it to asciinema.org site.__
This is the single most important command in asciinema, since it is how you This is the single most important command in asciinema, since it is how you
utilize this tool's main job. utilize this tool's main job.
By running `asciinema rec` you start a new recording session. The command By running `asciinema rec [filename]` you start a new recording session. The
(process) that is recorded can be specified with `-c` option (see below), and command (process) that is recorded can be specified with `-c` option (see
defaults to `$SHELL` which is what you want in most cases. below), and defaults to `$SHELL` which is what you want in most cases.
Recording finishes when you exit the shell (hit <kbd>Ctrl+D</kbd> or type Recording finishes when you exit the shell (hit <kbd>Ctrl+D</kbd> or type
`exit`). If the recorded process is not a shell than recording finishes when `exit`). If the recorded process is not a shell then recording finishes when
the process exits. the process exits.
If the `filename` argument is given then the resulting recording (called
[asciicast](doc/asciicast-v1.md)) is saved to a local file. It can later be
replayed with `asciinema play <filename>` and/or uploaded to asciinema.org with
`asciinema upload <filename>`. If the `filename` argument is omitted then
(after asking for confirmation) the resulting asciicast is uploaded to
asciinema.org for further playback in a web browser.
`ASCIINEMA_REC=1` is added to recorded process environment variables. This `ASCIINEMA_REC=1` is added to recorded process environment variables. This
can be used by your shell's config file (`.bashrc`, `.zshrc`) to alter the can be used by your shell's config file (`.bashrc`, `.zshrc`) to alter the
prompt or play a sound when shell is being recorded. prompt or play a sound when shell is being recorded.
Available options: Available options:
* `-c` - command to record (if none given a new shell instance is recorded) * `-c, --command=<command>` - Specify command to record, defaults to $SHELL
* `--max-wait` - reduce recorded terminal inactivity to maximum of <max-wait> seconds (0 turns off) * `-t, --title=<title>` - Specify title of the asciicast
* `-t` - set asciicast title (can be also set later, on the site) * `-w, --max-wait=<sec>` - Reduce recorded terminal inactivity to max <sec> seconds
* `-y` - upload immediately after shell exits, without asking for confirmation * `-y, --yes` - Answer yes to all prompts (e.g. upload confirmation)
## `play <filename>`
__Replay recorded asciicast in a terminal.__
This command replays given asciicast (as recorded by `rec` command) directly in
your terminal.
NOTE: it is recommended to run it in a terminal of dimensions not smaller than
the one used for recording as there's no "transcoding" of control sequences for
new terminal size.
## `upload <filename>`
__Upload recorded asciicast to asciinema.org site.__
This command uploads given asciicast (as recorded by `rec` command) to
asciinema.org for further playback in a web browser.
`asciinema rec demo.json` + `asciinema play demo.json` + `asciinema upload
demo.json` is a nice combo for when you want to review an asciicast before
publishing it on asciinema.org.
## `auth` ## `auth`
__Assign local API token to asciinema.org account.__ __Assign local API token to asciinema.org account.__
Every machine you install asciinema recorder on you get a new unique API On every machine you install asciinema recorder, you get a new, unique API
token. This command is used to connect this local API token with your token. This command connects this local token with your asciinema.org account,
asciinema.org account. and links all asciicasts recorded on this machine with the account.
This command displays the URL you should open in your web browser. If you This command displays the URL you should open in your web browser. If you never
never logged in to asciinema.org then your account will be automatically logged in to asciinema.org then your account will be created when opening the
created when opening the URL. URL.
NOTE: it is __necessary__ to do this if you want to __edit or delete__ your NOTE: it is __necessary__ to do this if you want to __edit or delete__ your
recordings on asciinema.org. recordings on asciinema.org.