yoinks README

The project's README from github.com/pablostanley/yoinks. As one markdown file: README.md.

yoinks

yoinks

yoink any video. paste. yoink. done.

Download videos from YouTube, X/Twitter, Instagram, Threads, TikTok and 1,800+ other sites — right from your terminal. Paste a url, pick a resolution (or audio-only mp3), done. No popups, no fake download buttons, no sketchy redirects.

yoinks home screen — paste a link and hit yoink

Install

npm install -g yoinks

Or try it without installing anything:

npx yoinks

Requires Node 18+. Everything else (yt-dlp, ffmpeg) is fetched or bundled automatically.

Usage

$ yoinks https://youtu.be/dQw4w9WgXcQ    # straight to the format picker
$ yoinks                                 # prompts for a url
$ yoinks --theme light                   # force the light palette

yoinks takes over the terminal (full-screen, centered — and restores your scrollback on exit). Pick a format with ↑/↓ (or j/k, or number keys) and hit enter. esc goes back, ^c quits. Or just use the mouse — the yoink button, the format list and the footer hints are all clickable, and clicking the logo takes you back home. Files are saved to ~/Downloads, and the file path is printed to your terminal when you're done.

The default auto theme uses your terminal's own foreground and background, so it follows light and dark terminal themes without guessing. Press ^t or click the theme control in the footer to cycle through auto, light, and dark for the current session. Use --theme auto, --theme light, or --theme dark to choose the starting theme for one launch.

yoinks format picker — resolutions with estimated file sizes, plus audio-only mp3

How it works

Development

npm install
npm run build        # bundle to dist/ with tsup
npm run dev          # rebuild on change
node dist/cli.js <url>
npm run typecheck

To try it as a global command without publishing: npm link, then run yoinks anywhere.

Roadmap

A note on fair use

yoinks is a personal-archiving tool. Downloading content may violate a platform's terms of service — only download what you have the right to keep, and be excellent to creators.

License

MIT

yoinks (pablostanley/yoinks)

Searching Database…

What is this?yoinks is a terminal tool that downloads videos from YouTube, X/Twitter, Instagram, Threads, TikTok and 1,800+ other sites — just paste a url and pick a resolution or audio-only mp3.
Is this a CLI script or does it have a UI?It is a full-screen terminal UI (TUI) built with Ink (React for the terminal) — you navigate with arrow keys, j/k, number keys, or your mouse.
How do I install and run it?Install globally with npm i -g yoinks and run yoinks, or try it instantly with npx yoinks — no setup needed beyond Node.
Do I need Python or ffmpeg installed first?You just need Node 18+; yt-dlp and ffmpeg are fetched or bundled automatically on first run, no Python required.
Does it support batch downloads or playlists yet?Not yet — playlist and multi-video thread support, scriptable --best/--mp3 flags, and a curl installer are all still on the roadmap as unchecked items.
Where do downloaded files end up?Files are saved to your local ~/Downloads folder, and the path is printed in the terminal when done.
Is there any legal catch to using this?It's MIT licensed, but the author frames it as a personal-archiving tool and warns that downloading content may violate a platform's terms of service.
Can I pick the theme or does it follow my terminal?By default it auto-detects your terminal's foreground/background colors; you can cycle auto/light/dark with ^t, or set a starting theme with --theme auto/light/dark.
How does the yt-dlp binary get installed?On first run yoinks downloads a standalone yt-dlp binary to ~/.yoinks/bin (no Python needed), or uses your own yt-dlp if one is already installed.
Can I try it without installing anything?Yes — run npx yoinks to try it without a permanent global install.
Size
0.3 MB
Stars
6K
Updated
CommitJul 17
Age
3mo
Commits · 90 Days