termstage 0.4.1

Fake terminal demos. YAML in, SVG out. No recording.

termstage

Generate polished terminal demo SVGs from a YAML file. No recording, no live shell, no asciinema.

Write what you want the terminal to show. Get a clean SVG you can drop into any README, doc, or portfolio.

---

Install

As a standalone tool (recommended):

pipx install termstage
# or
uv tool install termstage

Into a project:

uv add termstage
# or
pip install termstage

---

The Flow

1. Scaffold a starter file

termstage init

Creates demo.yaml in the current directory with example steps you can edit.

2. Edit demo.yaml

Open demo.yaml and replace the example steps with your own commands and output. See YAML format below.

3. Preview in browser

termstage preview demo.yaml

Opens a rendered SVG in your default browser. Iterate here until it looks right.

4. Render to SVG

# Static SVG
termstage render demo.yaml

# Animated CSS typewriter (recommended for READMEs)
termstage render demo.yaml --animated

# Custom output path
termstage render demo.yaml --animated -o assets/demo.svg

5. Embed in your README

![demo](demo.svg)

Or for more control over sizing:

<img src="demo-animated.svg" alt="demo" width="700">

The animated SVG uses pure CSS — no JavaScript. Works on GitHub, GitLab, and anywhere SVG is rendered.

---

YAML Format

title: "my-cli"        # Title bar text
theme: dark            # dark | light | dracula | nord  (default: dark)
prompt: "$ "           # Prompt string (default: "$ ")
width: 700             # SVG width in pixels (default: 700)

steps:
  - cmd: "my-cli --version"
    output: "my-cli 1.0.0"

  - cmd: "my-cli process data.csv"
    output: |
      Reading data.csv...
      Processed 10,000 rows
      Output → results.jsonl

  - comment: "# Comments render without a prompt, styled as code comments"

  - cmd: "my-cli --help"
    output: |
      Usage: my-cli [OPTIONS] COMMAND

        process   Process a CSV file
        export    Export results

      Options:
        --help    Show this message and exit.

Step types

Type	Fields	Description
cmd	cmd, output (optional)	Renders prompt + command + output
comment	comment	Renders a line styled as a code comment, no prompt

Top-level fields

Field	Default	Description
title	"terminal"	Title bar text
theme	dark	Colour theme
prompt	"$ "	Prompt string
width	700	SVG width in pixels

---

Themes

termstage themes

Theme	Background	Based on
dark	#1e1e1e	VS Code Dark+ (default)
light	#ffffff	Clean light terminal
dracula	#282a36	Dracula
nord	#2e3440	Nord

Set with theme: <name> in your YAML.

---

Commands

Command	Description
termstage init [output.yaml]	Scaffold a starter YAML (default: demo.yaml)
termstage render <file.yaml>	Render static SVG
termstage render <file.yaml> --animated	Render animated CSS typewriter SVG
termstage render <file.yaml> -o out.svg	Custom output path
termstage preview <file.yaml>	Render and open in browser
termstage preview <file.yaml> --animated	Preview animated version
termstage themes	List available themes

---

License

MIT