Home

Awesome

NOTICE

This project is no longer actively maintained, it should still work for the foreseeable future


<p align="center"> <a> <img src=.assets/logo.png></a> <br /> <br /> <a href="https://github.com/pystardust/ytfzf/stargazers"><img src="https://img.shields.io/github/stars/pystardust/ytfzf?color=orange&logo=github&style=flat-square"></a> <a href="https://github.com/pystardust/ytfzf/graphs/contributors"><img src="https://img.shields.io/github/contributors/pystardust/ytfzf?style=flat-square"></a> <img src="https://img.shields.io/static/v1?color=%231831ad&message=Euro20179&label=Maintainer&style=flat-square" alt="Maintainer: Euro20179"> <a href="https://github.com/pystardust/ytfzf/releases/tag/v1.1.1"><img src="https://img.shields.io/github/v/tag/pystardust/ytfzf?style=flat-square"> </a> <a href="https://github.com/pystardust/ytfzf/commits/master"><img src="https://img.shields.io/github/commit-activity/m/pystardust/ytfzf?color=green&style=flat-square"></a> <a href="https://discord.gg/kupWznHjRJ"><img src="https://img.shields.io/discord/815609275644117022?color=yellow&logo=discord&style=flat-square" alt="Discord"></a> <a href="https://matrix.to/#/#ytfzf-chat:matrix.org"><img src="https://img.shields.io/static/v1?color=%230eb687&message=chat&logo=matrix&label=matrix&style=flat-square" alt="Discord"></a> <br /> <br /> <i>A POSIX script that helps you find Youtube videos (without API) and opens/downloads them using mpv/youtube-dl</i> <hr> </p> <h1 align="center"> This is a little showcase </h1> <p align="center"> <img src=.assets/ytfzf.gif width="100%"> </p>

Table Of Contents


Dependencies

There are only 2 required dependencies, however the rest require some configuration before you can replace them.

Required dependencies

Recommended dependencies

Optional dependencies

Thumbnail Viewers

ProgramWayland Support
kitty (requires ueberzugpp)
iterm2 (requires ueberzugpp)
sixel (requires ueberzugpp)
sway (requires ueberzugpp)✅ (only on sway)
wayland (requires ueberzugpp)
chafa
catimg
imv
mpv
swayimgonly on sway
swayimg (-T swayimg-hyprland)only on hyprland

Install

<a href="https://repology.org/metapackage/ytfzf"> <img src="https://repology.org/badge/vertical-allrepos/ytfzf.svg" alt="Repo status" align="right"> </a>

if on linux and installed using make on version 2.0 or prior, run sudo make uninstall-old first

  1. Install the dependencies listed above
  2. Run the following commands
git clone https://github.com/pystardust/ytfzf
cd ytfzf
sudo make install doc

Addons

Addons are extra features that will not be as supported as everything built into ytfzf itself.

Addons are located in addons, copy any addon to ~/.config/ytfzf/{addon-type}/{addon}, and give it execute permissions.

You may also just copy the entire addon folder type, eg: cp -r addons/thumbnail-viewers ~/.config/ytfzf/

Usage

To use a scraper addon run ytfzf -c <scraper> ...

To use a thumbnail-viewer addon run ytfzf -T <viewer> ...

To use a interface addon run ytfzf -i <interface> ...

To use a url-handler addon run ytfzf -u <handler> ...

To use a sort-name addon run ytfzf --sort-name=<sort-name> ...

To use an extension addon run ytfzf -e <extension> ...


Features


Examples

Search with thumbnails

ytfzf -t <search>

Use dmenu as the menu instead of fzf

ytfzf -D <search>

Print the link of the selected video instead of playing it

ytfzf -L <search>

Search Odysee instead of youtube

ytfzf -cO <search>

Use the chafa thumbnail viewer, pass --vo=sixel, and --quiet to mpv, scrape odysee with the search odysee search, youtube with the search: youtube search, and also scrape subscriptions

ytfzf -t -T chafa --url-handler-opts='--vo=sixel --quiet' -cO,Y,SI --multi-search odysee search,youtube search

Configuration

Everything that is an option can also be configured in ~/.config/ytfzf/conf.sh.

In addition, the video player and other things may be changed here

Here is a sample configuration (please dont use it)

For more information, see ytfzf(5) which should be installed, if it's not see the wiki.


Bugs

Contributing

Feel free to contribute, and add your name to the credits, please use the development branch. For more information see contributing

Credits

UserContributionsDonate
Pystardustcontributions
Euro20179contributions
Simonhughxyzcontributions
Jac-Zaccontributions
Mudskipper875contributions
Gardocktcontributions
qoheniaccontributions
mathistocontributions