Asciinema
Asciinema is a CLI tool records and share terminal sessions, you can embed asciinema videos into Markdown content with this shortcode.
Donate
Become a backer or sponsor to support our work.
On this page
Sponsors
Syntax
1{{< asciinema [id] >}}
Parameters
id
| Position | Name | Type | Required | Default | Since | Example |
|---|---|---|---|---|---|---|
#0 | id | string | ✓ | - | - | - |
The asciicast ID.
theme
| Position | Name | Type | Required | Default | Since | Example |
|---|---|---|---|---|---|---|
| - | theme | string | - | - | - | - |
Theme.
Available options: asciinema, tango, solarized-dark, solarized-light, monokai.
autoplay
| Position | Name | Type | Required | Default | Since | Example |
|---|---|---|---|---|---|---|
| - | autoplay | boolean | - | true | - | - |
Whether to auto play video.
speed
| Position | Name | Type | Required | Default | Since | Example |
|---|---|---|---|---|---|---|
| - | speed | number | - | 1 | - | - |
Playback speed.
cols
| Position | Name | Type | Required | Default | Since | Example |
|---|---|---|---|---|---|---|
| - | cols | number | - | - | - | - |
Used to override width (in characters) of the emulated terminal.
rows
| Position | Name | Type | Required | Default | Since | Example |
|---|---|---|---|---|---|---|
| - | rows | number | - | - | - | - |
Used to override height (in lines) of the emulated terminal.
Examples
Default Asciinema
Source
1{{< asciinema 573031 >}}Result
Asciinema with Theme
Source
1{{< asciinema id=573031 theme=solarized-dark >}}Result
Asciinema with Auto Play
Source
1{{< asciinema id=573031 autoplay=true >}}Result
Asciinema with Speed
Source
1{{< asciinema id=573031 speed=2.5 >}}Result
Asciinema with Cols and Rows
Source
1{{< asciinema id=573031 cols=120 rows=20 >}}Result