Skip to main content

Editor Support

VS Code extension

QuikGIF ships a Visual Studio Code extension that adds syntax highlighting and command snippets for .qgif scripts:

  • Highlighting for every command, structural keywords (duration, continue, as, region, …), $variables, strings, numbers, and # comments.
  • A snippet for each command — type a command name (e.g. record, capture-window, spotlight) and press Tab to expand it with argument placeholders.

Install from source

The extension lives in the vscode-extension/ directory of the QuikGIF repository. To run it locally:

git clone https://github.com/ringo380/quikgif.git
cd quikgif/vscode-extension

Open the folder in VS Code and press F5 to launch an Extension Development Host, then open any .qgif file.

How it stays in sync

The grammar and snippets are generated from QuikGIF's own command list — the same data the CLI prints with quikgif script --list-commands. They are never hand-edited:

quikgif script --list-commands --format json > vscode-extension/syntaxes/commands.json
node vscode-extension/scripts/generate.mjs

A continuous-integration check fails if the committed extension files drift from the engine, so highlighting and snippets always match the commands your installed QuikGIF supports.