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…

6K ·GitHub
Yoinks
这是什么？yoinks 是一个终端工具，可以从 YouTube、X/Twitter、Instagram、Threads、TikTok 等 1800 多个网站下载视频——只需粘贴链接，然后选择分辨率或纯音频 mp3。
这是命令行脚本，还是有界面？它是用 Ink（面向终端的 React）构建的全屏终端界面（TUI）——可以用方向键、j/k、数字键或鼠标来操作。
怎么安装和运行？用 npm i -g yoinks 全局安装后运行 yoinks，或者用 npx yoinks 即时试用——除了 Node 之外无需任何配置。
需要先装好 Python 或 ffmpeg 吗？只需要 Node 18+；yt-dlp 和 ffmpeg 会在首次运行时自动获取或内置，不需要 Python。
现在支持批量下载或播放列表吗？还不支持——播放列表和多视频推文串支持、可脚本化的 --best/--mp3 参数以及 curl 安装器都还在路线图上，属于未完成项。
下载的文件保存在哪里？文件会保存到本地的 ~/Downloads 文件夹，完成后路径会打印在终端里。
使用它有什么法律上的注意事项吗？它采用 MIT 许可证，但作者把它定位为个人存档工具，并警告下载内容可能违反平台的服务条款。
可以自选主题吗，还是跟随终端配色？默认会自动检测终端的前景/背景颜色；可以用 ^t 在 auto/light/dark 之间切换，也可以用 --theme auto/light/dark 设置初始主题。
yt-dlp 这个二进制是怎么装上的？首次运行时，yoinks 会把独立的 yt-dlp 二进制下载到 ~/.yoinks/bin（无需 Python）；如果你已经装了 yt-dlp，它会直接用你自己的。
不安装任何东西能试用吗？可以——运行 npx yoinks 即可试用，无需永久全局安装。
What are similar projects?cobalt, pytube, lux, TikTokDownloader, downvid, youtube-dl, YoutubeDownloader, N_m3u8DL-CLI
Which topics is it in?media-downloader, instagram, youtube-downloader, tiktok, twitter, video-downloader, download, npm-package, downloader, video-processing, ffmpeg, tui
Creator
pablostanley
Size
0.3 MB
Stars
6K
Updated
CommitJul 17
Age
3mo
Commits · 90 Days