Skip to main content

Documentation Index

Fetch the complete documentation index at: https://tuireel.micr.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Install Tuireel

npm install -g tuireel
Tuireel requires ffmpeg to be installed on your system for video encoding. Install it with brew install ffmpeg (macOS), apt install ffmpeg (Ubuntu), or download from ffmpeg.org.

​
Create Your First Recording

1

Initialize a config

Run tuireel init to scaffold a .tuireel.jsonc config file:
tuireel init
This creates a starter config with a simple example. Tuireel starts with a delivery profile (readable-1080p by default), then lets you optionally add a visual preset like polished or demo.
2

Edit your steps

Open .tuireel.jsonc and replace the steps with your own. Here’s a simple example:
{
  "deliveryProfile": "readable-1080p",
  "preset": "polished",
  "output": "demo.mp4",
  "cols": 80,
  "rows": 24,
  "steps": [
    { "type": "launch", "command": "bash" },
    { "type": "type", "text": "echo 'Hello from Tuireel!'" },
    { "type": "press", "key": "Enter" },
    { "type": "pause", "duration": 2 }
  ]
}
3

Validate your config

Check your config for errors before recording:
tuireel validate .tuireel.jsonc
This validates the schema, checks step types, and reports any issues.
4

Record

Run the recording:
tuireel record .tuireel.jsonc
Tuireel will spawn a PTY, execute each step, capture frames, and encode the final video.
5

View your output

Open the generated demo.mp4 to see your recording. That’s it - a polished terminal demo with no manual editing.

​
Add Polish with Presets

Want instant polish? Stack a visual preset on top of your delivery profile: 
{
  "deliveryProfile": "readable-1080p",
  "preset": "polished",
  "output": "demo.mp4",
  "steps": [
    { "type": "launch", "command": "bash" },
    { "type": "type", "text": "echo 'Polished recording!'" },
    { "type": "press", "key": "Enter" },
    { "type": "pause", "duration": 2 },
  ],
}
The polished preset applies the Catppuccin theme, enables cursor overlay, HUD, and sound effects - all in one line. The delivery profile separately controls readability defaults and timing: fps is the final output cadence, while captureFps is the raw terminal capture cadence behind it. Available presets: polished, minimal, demo, silent.

​
Next Steps

Config Reference

Full reference for all config fields and options.

Steps Reference

Every step type explained with examples.

Themes

Browse and customize terminal color themes.

Presets

Pre-configured bundles for common recording styles.