Skip to content

asciinema

Recipe card from the charly-coder plugin (Images — the deployable catalog).

Property Value
Install files charly.yml (packages only)
Depends none

RPM: asciinema

Records terminal sessions as .cast files (asciicast v2 format). Recordings capture timing, input, and output — can be replayed with asciinema play, uploaded to asciinema.org, or converted to GIF/video.

RPM: asciinema · PAC: asciinema · DEB: asciinema — full parity.

# box charly.yml — compose the candy as an inline list in the box body
my-box:
candy:
base: fedora
candy: [asciinema]

Used by the record: check verb (a record: start step with record_mode: terminal) for terminal recording sessions. Also available standalone via asciinema rec.

Author ordered record: plan steps (the declarative verb served out-of-process by candy/plugin-record — there is no host charly check subcommand for it) and run them with charly check live <image> --filter record:

plan:
- check: a terminal recording starts
record:
method: start
record_name: demo
record_mode: terminal
context: [deploy]
- check: a command is sent into the recording
record:
method: cmd
record_name: demo
text: echo hello
context: [deploy]
- check: the recording stops and is copied out
record:
method: stop
record_name: demo
artifact: demo.cast
context: [deploy]
Terminal window
charly check live <image> --filter record # runs the steps above
asciinema play demo.cast # play back the copied-out artifact

Also available via the dev-tools candy (which includes asciinema among many other tools). This standalone candy is for boxes that need terminal recording without the full dev-tools bundle.

Use when the user asks about:

  • Terminal session recording
  • asciinema in containers
  • The asciinema candy
  • /charly-image:layer — candy authoring reference (charly.yml schema, plan-step verbs, service declarations)
  • /charly-check:check — declarative testing (check: block, charly check box, charly check live)