survos / ciine-bundle
Symfony tools for asciinema.org
Fund package maintenance!
Requires
- php: ^8.5
- sensiolabs/ansi-to-html: ^2.0
- symfony/config: ^8.1
- symfony/console: ^8.1
- symfony/dependency-injection: ^8.1
- symfony/finder: ^8.1
- symfony/http-client: ^8.1
- symfony/http-kernel: ^8.1
- symfony/options-resolver: ^8.1
- symfony/twig-bridge: ^8.1
- symfony/workflow: ^8.1
- twig/twig: ^3.4
Requires (Dev)
- phpstan/phpstan: ^2.0
- phpunit/phpunit: ^13.0
- survos/state-bundle: ^2.5
- symfony/framework-bundle: ^8.1
- symfony/panther: ^2.2
- symfony/routing: ^8.1
This package is auto-updated.
Last update: 2026-06-20 20:31:55 UTC
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