README

Symfony Bundle that provides some utilities for using asciinema 3.0 to create asciiCasts (aka ciineCasts)

Install asciinema

wget -qO- https://raw.githubusercontent.com/survos/ciine-bundle/main/install-asciinema.sh | bash

This installs the asciinema binary as /usr/local/bin/ciine and writes ~/.config/asciinema/config.toml with input capture enabled and recorded idle pauses capped at 0.2 seconds, which ciine needs for tutorial generation. The installer runs as your user and uses sudo only for the binary install.

To install it somewhere else:

wget -qO- https://raw.githubusercontent.com/survos/ciine-bundle/main/install-asciinema.sh | INSTALL_DIR=~/.local/bin TARGET_NAME=ciine bash

Install the bundle

composer require survos/ciine-bundle

Configure .bashrc

The easiest way to use this bundle is to pre-configure a few commands. You can also run everything manually, but it's a bit of a pain to track the files.

rec() { asciinema rec "casts/${PWD##*/}/$(date +%s).cast" --title="$1"; }

Usage

Start the recorder.

rec "Create the User Entity"
bin/console make:user

end with -D.

There are some special commands during the recording process.

composer req easyadmin
bin/console make:crud:dashboard
bin/console debug:route easyadmin
bin/console ciine:screenshot /admin
bin/console ciine:copy .env.local