Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/coah80/yoink/llms.txt

Use this file to discover all available pages before exploring further.

Yoink is a free, open-source media tool you can run on your own server. Paste any link from YouTube, TikTok, Twitter, Reddit, Instagram, and thousands of other sites — then download the video or audio, convert between formats, compress to a Discord-friendly size, or pull an entire image gallery. It ships as a single Go binary with an embedded Svelte PWA frontend and an optional Discord bot.

Quickstart

Build and run Yoink on your server in under five minutes.

Configuration

Configure environment variables, proxies, and Cobalt API keys.

Features

Explore downloading, conversion, compression, galleries, and more.

API Reference

Full REST API reference for integrating with Yoink programmatically.

What Yoink can do

Download

Videos and audio from 1000+ sites via yt-dlp with multi-provider fallback.

Playlists

Download entire YouTube playlists as a ZIP archive.

Convert

Convert between mp4, webm, mkv, mov, mp3, m4a, opus, wav, and flac.

Compress

Target a specific file size for Discord uploads using two-pass x264.

Galleries

Download image galleries from supported sites via gallery-dl.

Transcribe

Generate subtitles or captions using Whisper (local or OpenAI API).

Discord Bot

Use /yoink, /convert, and /compress slash commands directly in Discord.

PWA

Install as a mobile app and share links directly from any app.

Self-Host

One binary, no Docker required. Runs on Linux, macOS, and Windows.

Get up and running

1

Clone the repository

git clone https://github.com/coah80/yoink.git
cd yoink
2

Install system dependencies

Install yt-dlp, ffmpeg, and optionally gallery-dl on your server.
3

Configure environment variables

Copy .env.example to .env and set at minimum a BOT_SECRET and your COBALT_APIS if you want YouTube fast-path downloads.
4

Build and run

make build
./yoink   # serves API + frontend on :3001
The Discord bot is an optional separate binary. Run make bot then ./yoink-bot with BOT_TOKEN and BOT_API_URL set to add /yoink, /convert, and /compress to your server.

Build docs developers (and LLMs) love