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

First incomplete draft of v2 doc

Browse Source
This commit is contained in:
Marcin Kulik
2017-03-14 19:52:23 +01:00
parent 083cdaacad
commit 3ad8fa3dae
1 changed files with 35 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/asciicast-v2.md
View File

@@ -1,23 +1,43 @@
# asciicast file format (version 2) # asciicast file format (version 2)
asciicast file is JSON file containing meta-data like duration or title of the asciicast v2 file
recording, and the actual content printed to terminal's stdout during is [NDJSON (newline delimited JSON)](https://github.com/ndjson/ndjson-spec) file
recording. where:
## Attributes * __first line__ contains meta-data (duration, terminal size etc), encoded as JSON
object,
* __all subsequent lines__ contain stream data, _each line_ representing single stream
element (event), encoded as JSON array.
Every asciicast includes the following set of attributes: ## Meta-data
* `version` - set to 1, Every asciicast v2 includes the following meta-data:
* `version` - set to 2,
* `width` - terminal width (number of columns), * `width` - terminal width (number of columns),
* `height` - terminal height (number of rows), * `height` - terminal height (number of rows),
* `duration` - total duration of asciicast as floating point number, * `duration` - total duration of asciicast as floating point number,
* `command` - command that was recorded, as given via `-c` option to `rec`, * `command` - command that was recorded, as given via `-c` option to `rec`,
* `title` - title of the asciicast, as given via `-t` option to `rec`, * `title` - title of the asciicast, as given via `-t` option to `rec`,
* `env` - map of environment variables useful for debugging playback problems, * `env` - map of environment variables useful for debugging playback problems.
* `stdout` - array of "frames", see below.
### Frame Example meta-data line:
{ "version": 2, "width": 80, "height": 24, "duration": 1.515658, "command": "/bin/zsh", "title": null, "env": { "TERM": "xterm-256color", "SHELL": "/bin/zsh" } }
## Stream data
TODO: explain
[ time, event-type, event-data ]
TODO: explain
[ 1.001376, "o", "Hello world" ]
### "o" event - print to stdout
TODO: change this section to reflect new structure
Frame represents an event of printing new data to terminal's stdout. It is a 2 Frame represents an event of printing new data to terminal's stdout. It is a 2
element array containing **delay** and **data**. element array containing **delay** and **data**.
@@ -34,10 +54,12 @@ non-printable Unicode codepoints encoded as `\uXXXX`.
For example, frame `[5.4321, "foo\rbar\u0007..."]` means there was 5 seconds of For example, frame `[5.4321, "foo\rbar\u0007..."]` means there was 5 seconds of
inactivity between previous printing and printing of `foo\rbar\u0007...`. inactivity between previous printing and printing of `foo\rbar\u0007...`.
## Example asciicast v2 ## Complete asciicast v2 example
A very short asciicast may look like this: A very short asciicast v2 file looks like this:
{ "version": 1, "width": 80, "height": 24, "duration": 1.515658, "command": "/bin/zsh", "title": null, "env": { "TERM": "xterm-256color", "SHELL": "/bin/zsh" } } { "version": 2, "width": 80, "height": 24, "duration": 1.515658, "command": "/bin/zsh", "title": null, "env": { "TERM": "xterm-256color", "SHELL": "/bin/zsh" } }
[ 0.248848, "o", "\u001b[1;31mHello \u001b[32mWorld!\u001b[0m\n" ] [ 0.248848, "o", "\u001b[1;31mHello \u001b[32mWorld!\u001b[0m\n" ]
[ 1.001376, "o", "I am \rThis is on the next line." ] [ 1.001376, "o", "This is overwritten\rThis is better." ]
[ 0.143733, "o", " " ]
[ 0.541828, "o", "Bye!" ]