QuikGIF Script (.qgif)

Language support for QuikGIF .qgif automation scripts: syntax highlighting and command snippets for every QuikGIF scripting command.

QuikGIF is a macOS menubar GIF/WebP/APNG/MP4 recorder with a scriptable engine - you write a .qgif script to drive repeatable screen recordings and demos (open an app, type, click, spotlight a region, record, render). This extension makes those scripts pleasant to author in VS Code.

Features

Syntax highlighting for all 36 QuikGIF commands (record, capture-window, type, click, spotlight, dismiss-dialog, render, …), structural keywords (duration, region, as, audio, viewport, …), $variables, strings, numbers, and # comments.
Command snippets - start typing a command name and press Tab to expand it with argument placeholders. Snippets are provided for every command.

Quick start

Install this extension.
Open any .qgif file - highlighting applies automatically (the .qgif extension is registered to this language).
Start typing a command (e.g. record) and press Tab to expand the snippet, then fill in the placeholders.

# record a 3-second demo of a Terminal window
set output "demo.gif"
set fps 30

open "Terminal"
capture-window app "Terminal" as $term
resize 800 400

record $term duration 3.0 continue
type "echo Hello from QuikGIF!" enter
wait 1.0
remain

render

Requirements

This extension only provides editor support (highlighting + snippets). To actually run .qgif scripts you need QuikGIF and its CLI:
```
curl -fsSL https://quikgif.com/install.sh | sh
quikgif script my-demo.qgif
```
QuikGIF is a macOS app. The VS Code extension itself works on any platform for editing scripts.

Documentation

Full command reference: https://docs.quikgif.com/scripting/commands
Scripting guide and examples: https://docs.quikgif.com/scripting
QuikGIF home: https://quikgif.com

Notes

The grammar and snippets are generated directly from the QuikGIF engine's command manifest, so this extension stays in lock-step with the scripting language as new commands ship.

License

MIT