Platform-agnostic CLI toolkit for livestreamers.
reeln handles video manipulation, segment/highlight management, and media lifecycle — generic by default, sport-specific through configuration. Built by Streamn Dad.
- Python 3.11+
- ffmpeg 5.0+ with libx264, aac, and libass
Important: reeln requires ffmpeg installed on your system. It is used for all video processing — merging, rendering, overlays, and encoding. Install it before using reeln, then run
reeln doctorto verify.# macOS brew install ffmpeg # Ubuntu / Debian sudo apt install ffmpeg # Windows winget install ffmpeg
# With pip
pip install reeln
# With uv (recommended)
uv tool install reelnVerify everything is working:
reeln --version
reeln doctor # checks ffmpeg, codecs, config, permissions, plugins- Game lifecycle management — init, segment processing, highlights, events, finish
- Short-form rendering — crop, scale, speed, LUT, overlays — landscape to vertical/square
- FFmpeg-powered merging — concat segments into highlight reels with smart re-encoding
- Sport-agnostic segments — hockey periods, basketball quarters, soccer halves, and more
- Render profiles — save and reuse rendering settings, chain them with iterations
- Smart zoom — AI-powered tracking that follows the action (via plugin)
- Player overlays — roster-aware goal overlays with jersey number lookup
- Plugin architecture — lifecycle hooks for YouTube, Instagram, cloud uploads, and more
- Flexible configuration — JSON config, XDG paths, env var overrides, named profiles
- Cross-platform — macOS, Linux, Windows
# Initialize a hockey game
reeln game init roseville mahtomedi --sport hockey
# Process segments as the game progresses
reeln game segment 1
reeln game segment 2
reeln game segment 3
# Merge into a full-game highlight reel
reeln game highlights
# Render a vertical short for social media
reeln render short clip.mkv --crop crop --speed 0.5
# Finish the game
reeln game finishSee the examples for detailed walkthroughs of every workflow.
| Sport | Segment name | Count | Example directories |
|---|---|---|---|
| hockey | period | 3 | period-1/, period-2/, period-3/ |
| basketball | quarter | 4 | quarter-1/ through quarter-4/ |
| soccer | half | 2 | half-1/, half-2/ |
| football | half | 2 | half-1/, half-2/ |
| baseball | inning | 9 | inning-1/ through inning-9/ |
| lacrosse | quarter | 4 | quarter-1/ through quarter-4/ |
| generic | segment | 1 | segment-1/ |
| Command | Description |
|---|---|
reeln --version |
Show version and ffmpeg info |
reeln doctor |
Health check: ffmpeg, codecs, config, permissions, plugins |
| Command | Description |
|---|---|
reeln game init |
Set up game directory with sport-specific segments |
reeln game segment <N> |
Collect replays and merge segment highlights |
reeln game highlights |
Merge all segments into full-game highlight reel |
reeln game compile |
Compile event clips by type, segment, or player |
reeln game finish |
Finalize game and show summary |
reeln game prune |
Remove generated artifacts |
reeln game event list |
List registered events |
reeln game event tag |
Tag an event with type, player, metadata |
| Command | Description |
|---|---|
reeln render short |
Render 9:16 or 1:1 short from clip |
reeln render preview |
Fast low-res preview render |
reeln render apply |
Apply a render profile (full-frame, no crop) |
reeln render reel |
Assemble rendered shorts into a reel |
| Command | Description |
|---|---|
reeln config show |
Display resolved configuration |
reeln config doctor |
Validate config and warn on issues |
reeln config event-types |
Manage event types |
| Command | Description |
|---|---|
reeln plugins search |
Search the plugin registry |
reeln plugins info <name> |
Show plugin details and config schema |
reeln plugins install <name> |
Install a plugin from the registry |
reeln plugins update [name] |
Update a plugin or all installed |
reeln plugins list |
List installed plugins |
reeln plugins enable <name> |
Enable a plugin |
reeln plugins disable <name> |
Disable a plugin |
reeln uses a layered JSON config system:
- Bundled defaults — shipped with the package
- User config —
config.jsonin your XDG config directory - Game overrides —
game.jsonin the game directory - Environment variables —
REELN_<SECTION>_<KEY>
reeln config show- Full documentation — install, guides, CLI reference
- Examples — step-by-step walkthroughs for common workflows
GNU Affero General Public License v3.0 (AGPL-3.0)
- streamn.dad — project home
- Documentation — full docs
- @streamn_dad — highlights on Instagram
- YouTube — livestreams and highlights