Mirrors/asciinema
1
0
Fork 0
mirror of https://github.com/asciinema/asciinema.git synced 2025-12-16 11:48:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve config file documentation

Browse Source
This commit is contained in:
Marcin Kulik
2017-11-19 18:29:50 +01:00
parent 543baecc62
commit 226249db06
1 changed files with 49 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@@ -218,11 +218,11 @@ Playing from IPFS:
Available options: Available options:
* `-i, --idle-time-limit=<sec>` - Limit replayed terminal inactivity to max `<sec>` seconds * `-i, --idle-time-limit=<sec>` - Limit replayed terminal inactivity to max `<sec>` seconds
* `-s, --speed=<factor>` - Playback speedup (can be fractional) * `-s, --speed=<factor>` - Playback speed (can be fractional)
NOTE: it is recommended to run `asciinema play` in a terminal of dimensions not > For the best playback experience it is recommended to run `asciinema play` in
smaller than the one used for recording as there's no "transcoding" of control > a terminal of dimensions not smaller than the one used for recording, as
sequences for new terminal size. > there's no "transcoding" of control sequences for new terminal size.
### `cat <filename>` ### `cat <filename>`
@@ -291,41 +291,66 @@ saved in the file (unless the file already exists or you have set
The auto-generated, minimal config file looks like this: The auto-generated, minimal config file looks like this:
```ini
[api] [api]
token = <your-api-token-here> token = <your-api-token-here>
```
There are several options you can set in this file. Here's a config with all There are several options you can set in this file. Here's a config with all
available options set: available options set:
```ini
[api] [api]
token = <your-api-token-here>
; API server URL, default: https://asciinema.org
url = https://asciinema.example.com url = https://asciinema.example.com
; API token, autogenerated when uploading a recording for the first time
token = <your-api-token-here>
[record] [record]
; command to record, default: $SHELL
command = /bin/bash -l command = /bin/bash -l
stdin = no
; enable stdin (keyboard) recording, default: no
stdin = yes
; list of environment variables to capture, default: SHELL,TERM
env = SHELL,TERM,USER env = SHELL,TERM,USER
; limit recorded terminal inactivity to max n seconds, default: off
idle_time_limit = 2 idle_time_limit = 2
; answer "yes" to all interactive prompts, default: no
yes = true yes = true
; be quiet, suppress all notices/warnings, default: no
quiet = true quiet = true
[play] [play]
; playback speed (can be fractional), default: 1
speed = 2
; limit replayed terminal inactivity to max n seconds, default: off
idle_time_limit = 1 idle_time_limit = 1
```
The options in `[api]` section are related to API location and authentication. The options in `[api]` section are related to API location and authentication.
To tell asciinema recorder to use your own asciinema site instance rather than To tell asciinema recorder to use your own asciinema server instance rather than
the default one (asciinema.org), you can set `url` option. API URL can also be the default one (asciinema.org), you can set `url` option. API URL can also be
passed via `ASCIINEMA_API_URL` environment variable, as well as API token, via passed via `ASCIINEMA_API_URL` environment variable, and API token via
`ASCIINEMA_API_TOKEN` environment variable. `ASCIINEMA_API_TOKEN` environment variable.
The options in `[record]` and `[play]` sections have the same meaning as the The options in `[record]` and `[play]` sections have the same meaning as the
options you pass to `asciinema rec`/`asciinema play` command. If you happen to options you pass to `asciinema rec`/`asciinema play` command. If you happen to
often use either `-c`, `-w` or `-y` with these commands then consider saving it often use either `-c`, `-i` or `-y` with these commands then consider saving it
as a default in the config file. as a default in the config file.
*NOTE: If you want to publish your asciinema config file (in public dotfiles > If you want to publish your asciinema config file (in public dotfiles
repository) you __should__ remove `token = ...` line from the file and use > repository) you __should__ remove `token = ...` line from the file and use
`ASCIINEMA_API_TOKEN` environment variable instead.* > `ASCIINEMA_API_TOKEN` environment variable instead.
### Configuration file locations ### Configuration file locations