Effects
Cards, pauses, cuts, highlights, zooms, and redaction, from flags.
These flags add effects to run, export, attach, rec, and session exports.
Cards
reel export in.cast -o out.webp --intro 1s --intro-line "The Tea Shop" --outro 1s --outro-line "Thanks"
Without --intro-line, the intro shows the title. An outro needs a line. Both flags repeat, for more lines.
Pauses
reel export in.cast -o out.webp --pause --pause-at filter:typed
reel export in.cast -o out.webp --hold-last 2s
--pause pauses for a second at the end, with a badge. --pause-at MARK does the same at a mark, and repeats. --hold-last holds the last frame, with no badge.
The mouse
--mouse draws the pointer, clicks, and drags.
reel export in.cast -o out.webp --mouseCutting
--hide FROM,TO cuts the window between two marks. It repeats, and either mark may be empty for the start or end.
reel export in.cast -o out.webp --hide filter:start,filter:done
Highlight
reel export in.cast -o out.webp --highlight 're= Matcha.*0m ;dim=0.6;between=brew:start,brew:done'
Zoom
reel export in.cast -o out.webp --zoom 'cells=1,10,38,14;between=brew:start,brew:done'
Secrets
reel export in.cast -o out.webp --redact-regexp 'tea-[0-9a-f]+'
reel export in.cast -o out.webp --redact-env GITHUB_TOKEN
reel export in.cast -o out.webp --redact 'env=GITHUB_TOKEN;style=blur'
These can't be combined with a .cast output, which would keep the secret. And .snap and .json outputs skip effects. Redact has what it can't catch, so watch the result before sharing it.
Spec
--highlight, --zoom, and --redact take a spec: REGION[;KEY=VALUE]..., and they repeat.
| Region | Covers |
|---|---|
row=Y | One row, from 0 |
rows=Y0-Y1 | Rows from Y0 up to Y1 |
cells=X0,Y0,X1,Y1 | A rectangle of cells |
text=TEXT | Each place TEXT shows |
re=PATTERN | Each match of a regular expression |
env=NAME | Each place the value of a variable shows |
| Key | Effects | Is |
|---|---|---|
between=FROM,TO | All | The window between two marks. Either may be empty. |
ease=DUR | Highlight, zoom | How long to ease in and out |
dim=FACTOR | Highlight | How much to darken the rest, from 0 to 1 |
outline=#RRGGBB[:PX] | Highlight | A border |
padding=PX | Highlight | Undimmed pixels around the region |
scale=FACTOR | Zoom | How many times larger |
anchor=X,Y | Zoom | Where it sits, as a fraction of the grid |
style=blur|block|replace:C | Redact | How it hides |
Values can't contain ;, so neither can a region's text or pattern. Quote specs, since your shell cares about ;.
In a tape
Tapes take the same spec, as commands:
Highlight "re=ERROR.*;dim=0.5"
Zoom "cells=0,0,40,10"
Redact "env=GITHUB_TOKEN"See the effects themselves for what they do in detail.
Last updated on