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.

Tuireel supports two advanced config patterns: multi-video configs for producing multiple recordings from a single file, and step includes for sharing reusable step sequences across configs.

​
Multi-video Configs

Instead of a single config object, define a videos array to produce multiple recordings in one run: 
{
  "defaults": {
    "deliveryProfile": "readable-1080p",
    "preset": "polished",
    "theme": "catppuccin",
    "cols": 80,
    "rows": 24,
    "fps": 30,
    "captureFps": 12,
  },
  "videos": [
    {
      "name": "install",
      "output": "videos/install.mp4",
      "steps": [
        { "type": "launch", "command": "bash" },
        { "type": "type", "text": "npm install my-cli" },
        { "type": "press", "key": "Enter" },
        { "type": "pause", "duration": 3 },
      ],
    },
    {
      "name": "usage",
      "output": "videos/usage.mp4",
      "steps": [
        { "type": "launch", "command": "bash" },
        { "type": "type", "text": "my-cli --help" },
        { "type": "press", "key": "Enter" },
        { "type": "pause", "duration": 2 },
      ],
    },
  ],
}

​
How It Works

  • Each video entry gets its own output file and recording
  • The defaults object provides shared settings - any field you’d normally put at the top level (deliveryProfile, preset, theme, sound, cursor, HUD, fps, captureFps, cols, rows, etc.)
  • Each video can override any default with its own value
  • Every video must have a name (used for identification) and output (output file path)
  • Each video must define its own steps array
  • fps always means final output cadence, while captureFps is the raw terminal capture cadence

​
Video Definition Fields

FieldTypeRequiredDescription
namestringYesUnique name for this video
outputstringYesOutput file path
stepsarrayYesSteps for this video
deliveryProfilestringNoOverride timing + readability profile
presetstringNoOverride preset for this video
formatstringNoOverride format (mp4, webm, gif)
themestring or objectNoOverride theme
soundobjectNoOverride sound config
cursorobjectNoOverride cursor config
hudobjectNoOverride HUD config
fpsnumberNoOverride final output cadence
captureFpsnumberNoOverride raw capture cadence
colsnumberNoOverride terminal width
rowsnumberNoOverride terminal height

​
Step Includes

Extract reusable step sequences into separate JSONC files and reference them with $include: 
{
  "output": "demo.mp4",
  "steps": [
    { "$include": "./shared/setup.jsonc" },
    { "type": "type", "text": "echo 'Main demo starts here'" },
    { "type": "press", "key": "Enter" },
    { "type": "pause", "duration": 2 },
  ],
}

​
Include File Format

Include files must define a steps array: 
// shared/setup.jsonc
{
  "steps": [
    { "type": "launch", "command": "bash" },
    { "type": "type", "text": "cd my-project" },
    { "type": "press", "key": "Enter" },
    { "type": "pause", "duration": 1 },
  ],
}
The steps from the include file are inlined at the position of the $include directive - they replace the include object in the final step array.

​
Include Path Resolution

Include paths are resolved relative to the config file directory. If your config is at demos/.tuireel.jsonc and you reference "$include": "./shared/setup.jsonc", Tuireel looks for demos/shared/setup.jsonc.

​
Nested Includes

Include files can themselves contain $include directives. Nested paths are resolved relative to each include file’s own directory. Circular includes are detected and produce a clear error.

​
Multi-video with Includes

Combine both features for maximum reuse: 
{
  "defaults": {
    "deliveryProfile": "social-quick-share",
    "preset": "demo",
    "theme": "dracula",
    "cursor": { "visible": true },
  },
  "videos": [
    {
      "name": "quickstart",
      "output": "videos/quickstart.mp4",
      "steps": [
        { "$include": "./shared/setup.jsonc" },
        { "type": "type", "text": "my-cli init" },
        { "type": "press", "key": "Enter" },
        { "type": "pause", "duration": 3 },
      ],
    },
    {
      "name": "advanced",
      "output": "videos/advanced.mp4",
      "steps": [
        { "$include": "./shared/setup.jsonc" },
        { "type": "type", "text": "my-cli run --verbose" },
        { "type": "press", "key": "Enter" },
        { "type": "pause", "duration": 5 },
      ],
    },
  ],
}
Both videos share the same setup steps, but each has its own main content. Changes to shared/setup.jsonc automatically apply to every video that includes it.

​
When to Use These Features

ScenarioFeature
Demo suites with shared brandingMulti-video with defaults
Common setup steps across recordingsStep includes
Multiple output formats for same contentMulti-video (one per format)
Shared onboarding sequenceStep include referenced from multiple configs
CI-generated documentation videosMulti-video for batch recording