INSTALL.md

Installation

Dependencies

Fzf is optional, you can use an external menu (like dmenu) with the -D option (no thumbnail support).

• mpv
• youtube-dl
• jq - to parse json
• fzf (Optional if using: dmenu, rofi) - for menu
• notify-send (Optional) - for desktop notifications
• GNU shuf or ISC shuf (Optional) - for selecting random videos
• ueberzug (Optional) - for thumbnails
• other thumbnail options
  • chafa
  • catimg
  • jp2a

be sure to export YTFZF_THUMB_DISP_METHOD in your shell rc or thumb_disp_method in the config when not using ueberzug

Thumbnails only work with fzf as of now.

• Arch based

  sudo pacman -S jq mpv youtube-dl fzf
  

  For thumbnails

  sudo pacman -S ueberzug
  

• Debian based

  sudo apt install jq mpv youtube-dl fzf
  

  For thumbnails

  pip install ueberzug
  

  Note youtube-dl is usually outdated in debian repos, I suggest getting it from pip or youtube-dl github

• FreeBSD

  pkg install jq mpv youtube_dl fzf libnotify shuf
  

  For thumbnails

  pkg install --glob "py3*-ueberzug"
  

• Guix

  Ytfzf can be deployed on any GNU/Linux Systems, using Guix.

  To install in the user's default-profile, do guix package --install ytfzf

  To test without installation, do guix environment --pure --ad-hoc ytfzf curl nss-certs

• MacOS

  brew install jq mpv youtube-dl fzf
  

  At the moment thumbnail previews aren't working on MacOS

Installation-Options

1. Installation by direct download

   curl -sL "https://raw.githubusercontent.com/pystardust/ytfzf/master/ytfzf" | sudo tee /usr/local/bin/ytfzf >/dev/null && sudo chmod 755 /usr/local/bin/ytfzf

2. Arch users can install ytfzf from the AUR

   yay -S ytfzf
   

   Or alternatively from @JojiiOfficials pacman repository

3. FreeBSD users can install ytfzf as a binary package with pkg(8)

   pkg install ytfzf
   

   Or alternatively, build the port from source

   make -C /usr/ports/multimedia/ytfzf install
   

4. Gentoo users can install ytfzf from the nitratesky overlay

   eselect repository enable nitratesky
   emerge -a1 net-misc/ytfzf
   

5. Debian and Ubuntu LTS can get it from MPR

   git clone https://mpr.hunterwittenborn.com/ytfzf.git
   makedeb -i
   

Installation by cloning the repository

git clone https://github.com/pystardust/ytfzf
cd ytfzf

• Install with the Makefile

sudo make install

• Uninstall with the Makefile

sudo make uninstall