Skip to main content

CLI Reference

The quikgif command-line tool provides full access to QuikGIF's recording, processing, scripting, and MCP server capabilities.

Installation

brew install ringo380/tap/quikgif

Commands

CommandDescription
recordRecord a window, screen region, or the iOS Simulator as a GIF/video
shotCapture a single still image of a simulator, window, app, or screen region
processPost-process an existing GIF (resize, speed, idle cushioning)
scriptExecute a .qgif script for multi-step demo recordings
mcp-serverStart the MCP server for AI tool integration
mcp-installRegister QuikGIF MCP server with AI tools
mcp-uninstallRemove QuikGIF MCP server from AI tools
mcp-statusShow MCP registration status across AI tools
list-windowsList all capturable windows
benchmarkProfile encoding pipeline performance
analyticsOpt in/out of the anonymous usage heartbeat (off by default)

Quick Examples

Record a window for 5 seconds:

quikgif record --app Terminal --duration 5 -o demo.gif

Capture the iOS Simulator's native-resolution device framebuffer as a still:

quikgif shot --simulator-auto -o shot.png

Post-process an existing GIF:

quikgif process input.gif --max-width 600 --speed 1.5

Run a scripted recording:

quikgif script demo.qgif

Check MCP registration:

quikgif mcp-status