2025-03-14 21:59:59 -06:00
|
|
|
# asciinema
|
|
|
|
|
|
|
|
|
|
> Record and replay terminal sessions, and optionally share them on <https://asciinema.org>.
|
|
|
|
|
> See also: `terminalizer`.
|
2025-12-16 10:20:31 -07:00
|
|
|
> More information: <https://docs.asciinema.org/manual/cli/>.
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Associate the local install of `asciinema` with an asciinema.org account:
|
|
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`asciinema {{[a|auth]}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
2025-05-08 12:26:01 -06:00
|
|
|
- Make a new recording and save it to a local file (finish it with `<Ctrl d>` or type `exit`):
|
2025-03-14 21:59:59 -06:00
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`asciinema {{[r|record]}} {{path/to/recording.cast}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Replay a terminal recording from a local file:
|
|
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`asciinema {{[p|play]}} {{path/to/recording.cast}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Replay a terminal recording hosted on <https://asciinema.org>:
|
|
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`asciinema {{[p|play]}} https://asciinema.org/a/{{cast_id}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Make a new recording, limiting any idle time to at most 2.5 seconds:
|
|
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`asciinema {{[r|record]}} {{[-i|--idle-time-limit]}} 2.5`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Print the full output of a locally saved recording:
|
|
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`asciinema {{[ca|cat]}} {{path/to/recording.cast}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Upload a locally saved terminal session to asciinema.org:
|
|
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`asciinema {{[u|upload]}} {{path/to/recording.cast}}`
|
|
|
|
|
|
|
|
|
|
- Stream the current terminal on a local webpage:
|
|
|
|
|
|
|
|
|
|
`asciinema {{[st|stream]}} --local`
|