quikgif script
Execute a .qgif script to create multi-step GIF demos. Scripts can open apps, type commands, simulate input, record segments, and stitch them into a single polished GIF.
quikgif script <file> [options]
Arguments
| Argument | Description |
|---|---|
file | Path to the .qgif script file. Optional when --list-commands is used |
Flags
| Flag | Description |
|---|---|
--dry-run | Validate script syntax and run static analysis without executing |
--list-commands | Print all available script commands and exit |
--preview | Render a quick low-res preview (10fps, 400px, global palette) and open it |
-q, --quiet | Suppress progress output |
Quick Example
hello.qgif
open Terminal
wait 1
record $terminal duration 5 continue
type "echo 'Hello, world!'"
key Return
remain
render
quikgif script hello.qgif
Dry Run
Validate a script without executing it. Checks for syntax errors, undefined variables, missing record/render commands, and unreachable code:
quikgif script demo.qgif --dry-run
Preview Mode
Render a fast, low-resolution preview to check timing and flow before committing to a full-quality render:
quikgif script demo.qgif --preview
The preview is saved to /tmp/ and opened in Preview.app automatically.
Available Commands
Run quikgif script --list-commands to see all 24 script commands. For full syntax, settings, and variables reference, see the Scripting Reference.