1
Install
gem install shellfieTerminal visuals from YAML.
Shellfie generates repeatable terminal images, animations, and transcripts for documentation, tests, and release notes.
Repeatable by default.
Keep terminal visuals in version control instead of recapturing them by hand. The same source produces the same output on every run.
- Compose
- Render static or animated visuals without executing commands.
- Run
- Drive a real PTY with waits, assertions, limits, and redaction.
- Record
- Save editable sessions, then replay them offline and consistently.
- Ship
- Use the CLI, Docker image, or GitHub Action in your release flow.
Window styles
Switch the window chrome without rewriting the content.
theme: macos
theme: ubuntu
theme: windows
Quick start
Ruby 3.0+ and ImageMagick are required.
2
Describe
version: 1
theme: macos
title: "Terminal"
lines:
- prompt: "$ "
command: "echo hello"
- output: "hello"3
Generate
shellfie generate terminal.yml \
-o terminal.pngShellfie is open source.
Available under the MIT license.