mirror of
https://github.com/asciinema/asciinema.git
synced 2025-12-16 11:48:13 +01:00
Generate man page from markdown via pandoc
Thanks @KurtPfeifle! Closes #247
This commit is contained in:
Marcin Kulik
2
man/Makefile
Normal file
2
man/Makefile
Normal file
@@ -0,0 +1,2 @@
|
||||
asciinema.1: asciinema.1.md
|
||||
pandoc asciinema.1.md -s -t man -o asciinema.1
|
||||
378
man/asciinema.1
378
man/asciinema.1
@@ -1,120 +1,324 @@
|
||||
.TH "asciinema" "1" "April 11, 2017" "asciinema 1.4.0"
|
||||
.SH "NAME"
|
||||
asciinema \- terminal session recorder
|
||||
.SH "SYNOPSIS"
|
||||
.B asciinema
|
||||
.I [\-h] [\-\-version] command [<args>]
|
||||
.SH "DESCRIPTION"
|
||||
Terminal session recorder and the best companion of asciinema.org service.
|
||||
.\" Automatically generated by Pandoc 2.1.1
|
||||
.\"
|
||||
.TH "ASCIINEMA" "1" "" "Version 2.0" "asciinema"
|
||||
.hy
|
||||
.SH NAME
|
||||
.PP
|
||||
asciinema is composed of multiple commands, similar to git, apt-get or brew.
|
||||
\f[B]asciinema\f[] \- terminal session recorder
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[B]asciinema \-\-version\f[]
|
||||
.PD 0
|
||||
.P
|
||||
.PD
|
||||
\f[B]asciinema\f[] \f[I]command\f[] [\f[I]options\f[]] [\f[I]args\f[]]
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
asciinema lets you easily record terminal sessions and replay them in a
|
||||
terminal as well as in a web browser.
|
||||
.SH COMMANDS
|
||||
.PP
|
||||
asciinema is composed of multiple commands, similar to \f[C]git\f[],
|
||||
\f[C]apt\-get\f[] or \f[C]brew\f[].
|
||||
.PP
|
||||
When you run \f[B]asciinema\f[] with no arguments help message is
|
||||
displayed, listing all available commands with their options.
|
||||
.SS rec [\f[I]filename\f[]]
|
||||
.PP
|
||||
When you run asciinema with no arguments help messages is displayed, listing all available commands with their options.
|
||||
.SH "OPTIONS"
|
||||
.TP
|
||||
\-h, \-\-help
|
||||
Display help message
|
||||
.TP
|
||||
\-\-version
|
||||
Display version information
|
||||
.SH "COMMANDS"
|
||||
.B rec [<filename>]
|
||||
.RS 4
|
||||
Record terminal session.
|
||||
.PP
|
||||
This is the single most important command in asciinema, since it is how you utilize this tool's main job.
|
||||
By running \f[B]asciinema rec [filename]\f[] you start a new recording
|
||||
session.
|
||||
The command (process) that is recorded can be specified with
|
||||
\f[B]\-c\f[] option (see below), and defaults to \f[B]$SHELL\f[] which
|
||||
is what you want in most cases.
|
||||
.PP
|
||||
By running \fBasciinema rec\fP \fI[filename]\fP you start a new recording session. The command (process) that is recorded can be specified with \fI-c\fP option (see below), and defaults to \fB$SHELL\fP which is what you want in most cases.
|
||||
Recording finishes when you exit the shell (hit Ctrl+D or type
|
||||
\f[C]exit\f[]).
|
||||
If the recorded process is not a shell then recording finishes when the
|
||||
process exits.
|
||||
.PP
|
||||
Recording finishes when you exit the shell (hit \fBCtrl+D\fP or type \fIexit\fP). If the recorded process is not a shell than recording finishes when the process exits.
|
||||
If the \f[I]filename\f[] argument is omitted then (after asking for
|
||||
confirmation) the resulting asciicast is uploaded to
|
||||
asciinema\-server (https://github.com/asciinema/asciinema-server) (by
|
||||
default to asciinema.org), where it can be watched and shared.
|
||||
.PP
|
||||
If the \fIfilename\fP argument is given then the resulting recording is saved to a local file. It can later be replayed with \fBasciinema play\fP \fI<filename>\fP and/or uploaded to asciinema.org with \fBasciinema upload\fP \fI<filename>\fP. If the \fIfilename\fP argument is omitted then (after asking for confirmation) the resulting asciicast is uploaded to asciinema.org for further playback in a web browser.
|
||||
If the \f[I]filename\f[] argument is given then the resulting recording
|
||||
(called asciicast (doc/asciicast-v2.md)) is saved to a local file.
|
||||
It can later be replayed with \f[B]asciinema play <filename>\f[] and/or
|
||||
uploaded to asciinema server with \f[B]asciinema upload <filename>\f[].
|
||||
.PP
|
||||
\fBASCIINEMA_REC=1\fP is added to recorded process environment variables. This can be used by your shell's config file (\fI.bashrc\fP, \fI.zshrc\fP) to alter the prompt or play a sound when shell is being recorded.
|
||||
\f[B]ASCIINEMA_REC=1\f[] is added to recorded process environment
|
||||
variables.
|
||||
This can be used by your shell's config file (\f[C]\&.bashrc\f[],
|
||||
\f[C]\&.zshrc\f[]) to alter the prompt or play a sound when the shell is
|
||||
being recorded.
|
||||
.TP
|
||||
Available options:
|
||||
.RS 4
|
||||
.B Available options:
|
||||
\
|
||||
.RS
|
||||
.TP
|
||||
\-c, \-\-command
|
||||
specify command to record, defaults to $SHELL
|
||||
.B \f[C]\-\-stdin\f[]
|
||||
Enable stdin (keyboard) recording (see below)
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
\-t
|
||||
specify the title of the asciicast
|
||||
.B \f[C]\-\-append\f[]
|
||||
Append to existing recording
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
\-w, \-\-max\-wait
|
||||
reduce recorded terminal inactivity to max <sec> seconds
|
||||
.B \f[C]\-\-raw\f[]
|
||||
Save raw STDOUT output, without timing information or other metadata
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
\-y, \-\-yes
|
||||
answer "yes" to all prompts (e.g. upload confirmation)
|
||||
.B \f[C]\-\-overwrite\f[]
|
||||
Overwrite the recording if it already exists
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
\-q, \-\-quiet
|
||||
be quiet, suppress all notices/warnings (implies -y)
|
||||
.B \f[C]\-c,\ \-\-command=<command>\f[]
|
||||
Specify command to record, defaults to \f[B]$SHELL\f[]
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-e,\ \-\-env=<var\-names>\f[]
|
||||
List of environment variables to capture, defaults to
|
||||
\f[B]SHELL,TERM\f[]
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-t,\ \-\-title=<title>\f[]
|
||||
Specify the title of the asciicast
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-i,\ \-\-idle\-time\-limit=<sec>\f[]
|
||||
Limit recorded terminal inactivity to max \f[C]<sec>\f[] seconds
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-y,\ \-\-yes\f[]
|
||||
Answer \[lq]yes\[rq] to all prompts (e.g.\ upload confirmation)
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-q,\ \-\-quiet\f[]
|
||||
Be quiet, suppress all notices/warnings (implies \f[B]\-y\f[])
|
||||
.RS
|
||||
.RE
|
||||
.RE
|
||||
.PP
|
||||
.B play <filename>
|
||||
.RS 4
|
||||
Stdin recording allows for capturing of all characters typed in by the
|
||||
user in the currently recorded shell.
|
||||
This may be used by a player (e.g.
|
||||
asciinema\-player (https://github.com/asciinema/asciinema-player)) to
|
||||
display pressed keys.
|
||||
Because it's basically a key\-logging (scoped to a single shell
|
||||
instance), it's disabled by default, and has to be explicitly enabled
|
||||
via \f[B]\[en]stdin\f[] option.
|
||||
.SS play <\f[I]filename\f[]>
|
||||
.PP
|
||||
Replay recorded asciicast in a terminal.
|
||||
.PP
|
||||
This command replays given asciicast (as recorded by \fIrec\fP command) directly in your terminal.
|
||||
This command replays given asciicast (as recorded by \f[B]rec\f[]
|
||||
command) directly in your terminal.
|
||||
.PP
|
||||
When "-" is passed as a filename the asciicast is read from stdin.
|
||||
Following keyboard shortcuts are available:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
Space\ \-\ toggle\ pause,
|
||||
\&.\ \-\ step\ through\ a\ recording\ a\ frame\ at\ a\ time\ (when\ paused),
|
||||
Ctrl+C\ \-\ exit.
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
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.
|
||||
Playing from a local file:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
asciinema\ play\ /path/to/asciicast.cast
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
Playing from HTTP(S) URL:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
asciinema\ play\ https://asciinema.org/a/22124.cast
|
||||
asciinema\ play\ http://example.com/demo.cast
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
Playing from asciicast page URL (requires
|
||||
\f[C]<link\ rel="alternate"\ type="application/x\-asciicast"\ href="/my/ascii.cast">\f[]
|
||||
in page's HTML):
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
asciinema\ play\ https://asciinema.org/a/22124
|
||||
asciinema\ play\ http://example.com/blog/post.html
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
Playing from stdin:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
cat\ /path/to/asciicast.cast\ |\ asciinema\ play\ \-
|
||||
ssh\ user\@host\ cat\ asciicast.cast\ |\ asciinema\ play\ \-
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
Playing from IPFS:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
asciinema\ play\ dweb:/ipfs/QmNe7FsYaHc9SaDEAEXbaagAzNw9cH7YbzN4xV7jV1MCzK/ascii.cast
|
||||
\f[]
|
||||
.fi
|
||||
.TP
|
||||
Available options:
|
||||
.RS 4
|
||||
.B Available options:
|
||||
\
|
||||
.RS
|
||||
.TP
|
||||
\-w, \-\-max\-wait
|
||||
reduce replayed terminal inactivity to max \fIsec\fP seconds
|
||||
.B \f[C]\-i,\ \-\-idle\-time\-limit=<sec>\f[]
|
||||
Limit replayed terminal inactivity to max \f[C]<sec>\f[] seconds
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
\-s, \-\-speed
|
||||
speed up playback by factor \fIfactor\fP (can be fractional)
|
||||
.B \f[C]\-s,\ \-\-speed=<factor>\f[]
|
||||
Playback speed (can be fractional)
|
||||
.RS
|
||||
.RE
|
||||
.RE
|
||||
.SS cat <\f[I]filename\f[]>
|
||||
.PP
|
||||
Print full output of recorded asciicast to a terminal.
|
||||
.PP
|
||||
While \f[B]asciinema play \f[] replays the recorded session using timing
|
||||
information saved in the asciicast, \f[B]asciinema cat \f[] dumps the
|
||||
full output (including all escape sequences) to a terminal immediately.
|
||||
.PP
|
||||
\f[B]asciinema cat existing.cast >output.txt\f[] gives the same result
|
||||
as recording via \f[B]asciinema rec \-\-raw output.txt\f[].
|
||||
.SS upload
|
||||
.PP
|
||||
.B upload <filename>
|
||||
.RS 4
|
||||
Upload recorded asciicast to asciinema.org site.
|
||||
.PP
|
||||
This command uploads given asciicast (as recorded by \fIrec\fP command) to asciinema.org for further playback in a web browser.
|
||||
This command uploads given asciicast (recorded by \f[B]rec\f[] command)
|
||||
to asciinema.org, where it can be watched and shared.
|
||||
.PP
|
||||
\fBasciinema rec\fP \fIdemo.cast\fP + \fBasciinema play\fP \fIdemo.cast\fP + \fBasciinema upload\fP \fIdemo.cast\fP is a nice combo for when you want to review an asciicast before publishing it on asciinema.org.
|
||||
\f[B]asciinema rec demo.cast\f[] + \f[B]asciinema play demo.cast\f[] +
|
||||
\f[B]asciinema upload demo.cast\f[] is a nice combo if you want to
|
||||
review an asciicast before publishing it on asciinema.org.
|
||||
.SS auth
|
||||
.PP
|
||||
Link your install ID with your asciinema.org user account.
|
||||
.PP
|
||||
If you want to manage your recordings (change title/theme, delete) at
|
||||
asciinema.org you need to link your \[lq]install ID\[rq] with
|
||||
asciinema.org user account.
|
||||
.PP
|
||||
This command displays the URL to open in a web browser to do that.
|
||||
You may be asked to log in first.
|
||||
.PP
|
||||
Install ID is a random ID (UUID
|
||||
v4 (https://en.wikipedia.org/wiki/Universally_unique_identifier))
|
||||
generated locally when you run asciinema for the first time, and saved
|
||||
at \f[B]$HOME/.config/asciinema/install\-id\f[].
|
||||
It's purpose is to connect local machine with uploaded recordings, so
|
||||
they can later be associated with asciinema.org account.
|
||||
This way we decouple uploading from account creation, allowing them to
|
||||
happen in any order.
|
||||
.PP
|
||||
Note: A new install ID is generated on each machine and system user
|
||||
account you use asciinema on, so in order to keep all recordings under a
|
||||
single asciinema.org account you need to run \f[B]asciinema auth\f[] on
|
||||
all of those machines.
|
||||
.PP
|
||||
Note: asciinema versions prior to 2.0 confusingly referred to install ID
|
||||
as \[lq]API token\[rq].
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Record your first session:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
asciinema\ rec\ first.cast
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
Now replay it with double speed:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
asciinema\ play\ \-s\ 2\ first.cast
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
Or with normal speed but with idle time limited to 2 seconds:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
asciinema\ play\ \-i\ 2\ first.cast
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
You can pass \f[B]\-i 2\f[] to \f[B]asciinema rec\f[] as well, to set it
|
||||
permanently on a recording.
|
||||
Idle time limiting makes the recordings much more interesting to watch,
|
||||
try it.
|
||||
.PP
|
||||
If you want to watch and share it on the web, upload it:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
asciinema\ upload\ first.cast
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
The above uploads it to <https://asciinema.org>, which is a default
|
||||
asciinema\-server (<https://github.com/asciinema/asciinema-server>)
|
||||
instance, and prints a secret link you can use to watch your recording
|
||||
in a web browser.
|
||||
.PP
|
||||
You can record and upload in one step by omitting the filename:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
asciinema\ rec
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
You'll be asked to confirm the upload when the recording is done, so
|
||||
nothing is sent anywhere without your consent.
|
||||
.SH ENVIRONMENT
|
||||
.TP
|
||||
.B \f[B]ASCIINEMA_API_URL\f[]
|
||||
This variable allows overriding asciinema\-server URL (which defaults to
|
||||
https://asciinema.org) in case you're running your own asciinema\-server
|
||||
instance.
|
||||
.RS
|
||||
.RE
|
||||
.PP
|
||||
.B auth
|
||||
.RS 4
|
||||
Assign local API token to asciinema.org account.
|
||||
.PP
|
||||
On every machine you install asciinema recorder, you get a new, unique API
|
||||
token. This command connects this local token with your asciinema.org account,
|
||||
and links all asciicasts recorded on this machine with the account.
|
||||
.PP
|
||||
This command displays the URL you should open in your web browser. If you never
|
||||
logged in to asciinema.org then your account will be created when opening the
|
||||
URL.
|
||||
.PP
|
||||
NOTE: it is \fBnecessary\fP to do this if you want to edit or delete your
|
||||
recordings on asciinema.org.
|
||||
.PP
|
||||
You can synchronize your config file (which keeps the API token) across the
|
||||
machines but that's not necessary. You can assign new tokens to your account
|
||||
from as many machines as you want.
|
||||
.TP
|
||||
.B \f[B]ASCIINEMA_CONFIG_HOME\f[]
|
||||
This variable allows overriding config directory location.
|
||||
Default location is $XDG_CONFIG_HOME/asciinema (when $XDG_CONFIG_HOME is
|
||||
set) or $HOME/.config/asciinema.
|
||||
.RS
|
||||
.RE
|
||||
.SH "CONTRIBUTING"
|
||||
If you want to contribute to this project check out Contributing page: \fIhttps://asciinema.org/contributing\fP
|
||||
.SH "BUGS"
|
||||
All your bug reports and feature ideas are highly appreciated as they help to improve the quality and functionality of asciinema for everyone.
|
||||
.SH BUGS
|
||||
.PP
|
||||
As the service is built of several parts there are separate bug trackers:
|
||||
.TP
|
||||
https://github.com/asciinema/asciinema/issues
|
||||
issues and ideas for the command line recorder
|
||||
.TP
|
||||
https://github.com/asciinema/asciinema-server/issues
|
||||
issues and ideas for the website
|
||||
.TP
|
||||
https://github.com/asciinema/asciinema-player/issues
|
||||
issues and ideas for the javascript player
|
||||
.SH "AUTHORS"
|
||||
Developed with passion by \fBMarcin Kulik\fP and great open source contributors.
|
||||
See GitHub Issues: <https://github.com/asciinema/asciinema/issues>
|
||||
.SH AUTHORS
|
||||
.PP
|
||||
asciinema's lead developer is Marcin Kulik.
|
||||
.PP
|
||||
For a list of all contributors look here:
|
||||
<https://github.com/asciinema/asciinema/contributors>
|
||||
.PP
|
||||
This Manual Page was written by Marcin Kulik with help from Kurt
|
||||
Pfeifle.
|
||||
|
||||
257
man/asciinema.1.md
Normal file
257
man/asciinema.1.md
Normal file
@@ -0,0 +1,257 @@
|
||||
% ASCIINEMA(1) Version 2.0 | asciinema
|
||||
|
||||
NAME
|
||||
====
|
||||
|
||||
**asciinema** - terminal session recorder
|
||||
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
| **asciinema \-\-version**
|
||||
| **asciinema** _command_ \[_options_] \[_args_]
|
||||
|
||||
DESCRIPTION
|
||||
===========
|
||||
|
||||
asciinema lets you easily record terminal sessions and replay
|
||||
them in a terminal as well as in a web browser.
|
||||
|
||||
COMMANDS
|
||||
========
|
||||
|
||||
asciinema is composed of multiple commands, similar to `git`, `apt-get` or
|
||||
`brew`.
|
||||
|
||||
When you run **asciinema** with no arguments help message is displayed, listing
|
||||
all available commands with their options.
|
||||
|
||||
rec [_filename_]
|
||||
---
|
||||
|
||||
Record terminal session.
|
||||
|
||||
By running **asciinema rec [filename]** you start a new recording session. The
|
||||
command (process) that is recorded can be specified with **-c** option (see
|
||||
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
|
||||
`exit`). If the recorded process is not a shell then recording finishes when
|
||||
the process exits.
|
||||
|
||||
If the _filename_ argument is omitted then (after asking for confirmation) the
|
||||
resulting asciicast is uploaded to
|
||||
[asciinema-server](https://github.com/asciinema/asciinema-server) (by default to
|
||||
asciinema.org), where it can be watched and shared.
|
||||
|
||||
If the _filename_ argument is given then the resulting recording (called
|
||||
[asciicast](doc/asciicast-v2.md)) is saved to a local file. It can later be
|
||||
replayed with **asciinema play \<filename>** and/or uploaded to asciinema server
|
||||
with **asciinema upload \<filename>**.
|
||||
|
||||
**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
|
||||
prompt or play a sound when the shell is being recorded.
|
||||
|
||||
Available options:
|
||||
|
||||
:
|
||||
|
||||
`--stdin`
|
||||
: Enable stdin (keyboard) recording (see below)
|
||||
|
||||
`--append`
|
||||
: Append to existing recording
|
||||
|
||||
`--raw`
|
||||
: Save raw STDOUT output, without timing information or other metadata
|
||||
|
||||
`--overwrite`
|
||||
: Overwrite the recording if it already exists
|
||||
|
||||
`-c, --command=<command>`
|
||||
: Specify command to record, defaults to **$SHELL**
|
||||
|
||||
`-e, --env=<var-names>`
|
||||
: List of environment variables to capture, defaults to **SHELL,TERM**
|
||||
|
||||
`-t, --title=<title>`
|
||||
: Specify the title of the asciicast
|
||||
|
||||
`-i, --idle-time-limit=<sec>`
|
||||
: Limit recorded terminal inactivity to max `<sec>` seconds
|
||||
|
||||
`-y, --yes`
|
||||
: Answer "yes" to all prompts (e.g. upload confirmation)
|
||||
|
||||
`-q, --quiet`
|
||||
: Be quiet, suppress all notices/warnings (implies **-y**)
|
||||
|
||||
Stdin recording allows for capturing of all characters typed in by the user in
|
||||
the currently recorded shell. This may be used by a player (e.g.
|
||||
[asciinema-player](https://github.com/asciinema/asciinema-player)) to display
|
||||
pressed keys. Because it's basically a key-logging (scoped to a single shell
|
||||
instance), it's disabled by default, and has to be explicitly enabled via
|
||||
**--stdin** option.
|
||||
|
||||
play <_filename_>
|
||||
---
|
||||
|
||||
Replay recorded asciicast in a terminal.
|
||||
|
||||
This command replays given asciicast (as recorded by **rec** command) directly in
|
||||
your terminal.
|
||||
|
||||
Following keyboard shortcuts are available:
|
||||
|
||||
Space - toggle pause,
|
||||
. - step through a recording a frame at a time (when paused),
|
||||
Ctrl+C - exit.
|
||||
|
||||
Playing from a local file:
|
||||
|
||||
asciinema play /path/to/asciicast.cast
|
||||
|
||||
Playing from HTTP(S) URL:
|
||||
|
||||
asciinema play https://asciinema.org/a/22124.cast
|
||||
asciinema play http://example.com/demo.cast
|
||||
|
||||
Playing from asciicast page URL (requires `<link rel="alternate"
|
||||
type="application/x-asciicast" href="/my/ascii.cast">` in page's HTML):
|
||||
|
||||
asciinema play https://asciinema.org/a/22124
|
||||
asciinema play http://example.com/blog/post.html
|
||||
|
||||
Playing from stdin:
|
||||
|
||||
cat /path/to/asciicast.cast | asciinema play -
|
||||
ssh user@host cat asciicast.cast | asciinema play -
|
||||
|
||||
Playing from IPFS:
|
||||
|
||||
asciinema play dweb:/ipfs/QmNe7FsYaHc9SaDEAEXbaagAzNw9cH7YbzN4xV7jV1MCzK/ascii.cast
|
||||
|
||||
Available options:
|
||||
|
||||
:
|
||||
|
||||
`-i, --idle-time-limit=<sec>`
|
||||
: Limit replayed terminal inactivity to max `<sec>` seconds
|
||||
|
||||
`-s, --speed=<factor>`
|
||||
: Playback speed (can be fractional)
|
||||
|
||||
cat <_filename_>
|
||||
---
|
||||
|
||||
Print full output of recorded asciicast to a terminal.
|
||||
|
||||
While **asciinema play <filename>** replays the recorded session using timing
|
||||
information saved in the asciicast, **asciinema cat <filename>** dumps the full
|
||||
output (including all escape sequences) to a terminal immediately.
|
||||
|
||||
**asciinema cat existing.cast >output.txt** gives the same result as recording via
|
||||
**asciinema rec \-\-raw output.txt**.
|
||||
|
||||
upload <filename>
|
||||
---
|
||||
|
||||
Upload recorded asciicast to asciinema.org site.
|
||||
|
||||
This command uploads given asciicast (recorded by **rec** command) to
|
||||
asciinema.org, where it can be watched and shared.
|
||||
|
||||
**asciinema rec demo.cast** + **asciinema play demo.cast** + **asciinema upload
|
||||
demo.cast** is a nice combo if you want to review an asciicast before
|
||||
publishing it on asciinema.org.
|
||||
|
||||
auth
|
||||
---
|
||||
|
||||
Link your install ID with your asciinema.org user account.
|
||||
|
||||
If you want to manage your recordings (change title/theme, delete) at
|
||||
asciinema.org you need to link your "install ID" with asciinema.org user
|
||||
account.
|
||||
|
||||
This command displays the URL to open in a web browser to do that. You may be
|
||||
asked to log in first.
|
||||
|
||||
Install ID is a random ID ([UUID
|
||||
v4](https://en.wikipedia.org/wiki/Universally_unique_identifier)) generated
|
||||
locally when you run asciinema for the first time, and saved at
|
||||
**$HOME/.config/asciinema/install-id**. It's purpose is to connect local machine
|
||||
with uploaded recordings, so they can later be associated with asciinema.org
|
||||
account. This way we decouple uploading from account creation, allowing them to
|
||||
happen in any order.
|
||||
|
||||
Note: A new install ID is generated on each machine and system user account you use
|
||||
asciinema on, so in order to keep all recordings under a single asciinema.org
|
||||
account you need to run **asciinema auth** on all of those machines.
|
||||
|
||||
Note: asciinema versions prior to 2.0 confusingly referred to install ID as "API
|
||||
token".
|
||||
|
||||
EXAMPLES
|
||||
========
|
||||
|
||||
Record your first session:
|
||||
|
||||
asciinema rec first.cast
|
||||
|
||||
Now replay it with double speed:
|
||||
|
||||
asciinema play -s 2 first.cast
|
||||
|
||||
Or with normal speed but with idle time limited to 2 seconds:
|
||||
|
||||
asciinema play -i 2 first.cast
|
||||
|
||||
You can pass **-i 2** to **asciinema rec** as well, to set it permanently on a
|
||||
recording. Idle time limiting makes the recordings much more interesting to
|
||||
watch, try it.
|
||||
|
||||
If you want to watch and share it on the web, upload it:
|
||||
|
||||
asciinema upload first.cast
|
||||
|
||||
The above uploads it to <https://asciinema.org>, which is a
|
||||
default asciinema-server (<https://github.com/asciinema/asciinema-server>)
|
||||
instance, and prints a secret link you can use to watch your recording in a web
|
||||
browser.
|
||||
|
||||
You can record and upload in one step by omitting the filename:
|
||||
|
||||
asciinema rec
|
||||
|
||||
You'll be asked to confirm the upload when the recording is done, so nothing is
|
||||
sent anywhere without your consent.
|
||||
|
||||
ENVIRONMENT
|
||||
===========
|
||||
|
||||
**ASCIINEMA_API_URL**
|
||||
|
||||
: This variable allows overriding asciinema-server URL (which defaults to
|
||||
https://asciinema.org) in case you're running your own asciinema-server instance.
|
||||
|
||||
**ASCIINEMA_CONFIG_HOME**
|
||||
|
||||
: This variable allows overriding config directory location. Default location
|
||||
is $XDG\_CONFIG\_HOME/asciinema (when $XDG\_CONFIG\_HOME is set)
|
||||
or $HOME/.config/asciinema.
|
||||
|
||||
BUGS
|
||||
====
|
||||
|
||||
See GitHub Issues: <https://github.com/asciinema/asciinema/issues>
|
||||
|
||||
AUTHORS
|
||||
=======
|
||||
|
||||
asciinema's lead developer is Marcin Kulik.
|
||||
|
||||
For a list of all contributors look here: <https://github.com/asciinema/asciinema/contributors>
|
||||
|
||||
This Manual Page was written by Marcin Kulik with help from Kurt Pfeifle.
|
||||
Reference in New Issue
Block a user