Introduction
What shardreel does and how these docs are organised.
shardreel turns long gameplay recordings into vertical 9:16 clips for Shorts, Reels and TikTok. Point it at a video, and it finds the peak moments, adds word-by-word captions, and renders ready-to-upload files.
It runs on Apple Silicon Macs only. Transcription uses Whisper on the GPU through Metal, and encoding uses the Mac media engine through VideoToolbox. There is no cloud renderer and no subscription. An AI model is optional, and only used to rank candidates and write titles.
What you get
For each video, shardreel writes a folder containing:
NN_title.mp4, a 1080x1920 clip per momentNN_title.jpg, a thumbnail taken at the peakclips.json, with timestamps, title, hook, hashtags and a ready-to-paste caption
Two names
The product is called shardreel. The Rust engine and the data folder keep their internal name, clipforge, which is why you will see ~/.clipforge and CLIPFORGE_* environment variables in these docs.
How these docs are organised
Getting started
Install the tools, build the app and run your first job.
Guides
Task-based how-tos: layouts, captions, AI ranking, storage.
How it works
The pipeline, moment picking and caching in detail.
Reference
Every option, setting, file and HTTP route.
Rights
Clip your own gameplay, or streamers who allow it. Many run clipping programs. Reposting other people's streams without permission gets accounts struck.