Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pystardust/ytfzf
A posix script to find and watch youtube videos from the terminal. (Without API)
https://github.com/pystardust/ytfzf
cli dmenu fzf posix terminal ueberzug youtube
Last synced: about 1 month ago
JSON representation
A posix script to find and watch youtube videos from the terminal. (Without API)
- Host: GitHub
- URL: https://github.com/pystardust/ytfzf
- Owner: pystardust
- License: gpl-3.0
- Created: 2021-02-19T10:12:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T15:54:46.000Z (5 months ago)
- Last Synced: 2024-02-06T05:41:11.174Z (4 months ago)
- Topics: cli, dmenu, fzf, posix, terminal, ueberzug, youtube
- Language: Shell
- Homepage:
- Size: 4.74 MB
- Stars: 3,501
- Watchers: 38
- Forks: 282
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-browserless - Ytfzf - A posix script to find and watch youtube videos from the terminal. (Without API) (YouTube)
- Awesome-Linux-Software - 
A POSIX script that helps you find Youtube videos (without API) and opens/downloads them using mpv/youtube-dl
This is a little showcase
---
# Table Of Contents
- [`Dependencies`](#Dependencies)
- [`Install`](#Install)
- [`Features`](#Features)
- [`Examples`](#Examples)
- [`Configuration`](#Configuration)
- [`Bugs`](#Bugs)
- [`Contributing`](#Contributing)
- [`Credits`](#Credits)
---
# Dependencies
There are only 2 required dependencies, however the rest require some configuration before you can replace them.
## Required dependencies
- [`jq`](https://github.com/stedolan/jq)
- [`curl`](https://github.com/curl/curl)
## Recommended dependencies
- [`mpv`](https://github.com/mpv-player/mpv) (the default video and audio player)
- [`fzf`](https://github.com/junegunn/fzf) (the default menu selection screen)
## Optional dependencies
- [`yt-dlp`](https://github.com/yt-dlp/yt-dlp) (for downloading)
- [`dmenu`](https://tools.suckless.org/dmenu/) (only if using the -D option)
- [`ueberzugpp`](https://github.com/jstkdng/ueberzugpp)
- needed for the following thumbnail viewers:
- `kitty`, `iterm2`, `sixel`, and `ueberzug`
- the original [`ueberzug`](https://github.com/seebye/ueberzug) or any fork may be used if you only want to use the `ueberzug` viewer.
### Thumbnail Viewers
- **To use a thumbnail viewer include `-T ` in the command when running ytfzf**
| Program | Wayland Support |
| :--------------------------------------------------------------------- | :--------------------- |
| [`kitty`](https://github.com/kovidgoyal/kitty) (requires `ueberzugpp`) | ✅ |
| `iterm2` (requires `ueberzugpp`) | ✅ |
| `sixel` (requires `ueberzugpp`) | ✅ |
| `sway` (requires `ueberzugpp`) | ✅ (only on sway) |
| `wayland` (requires `ueberzugpp`) | ✅ |
| [`chafa`](https://github.com/hpjansson/chafa) | ✅ |
| [`catimg`](https://github.com/posva/catimg) | ✅ |
| [`imv`](https://git.sr.ht/~exec64/imv) | ✅ |
| [`mpv`](https://github.com/mpv-player/mpv) | ✅ |
| [`swayimg`](https://github.com/artemsen/swayimg) | only on `sway` |
| [`swayimg`](https://github.com/artemsen/swayimg) (-T swayimg-hyprland) | only on `hyprland` |
# Install
**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](#Dependencies)
2. Run the following commands
```sh
git clone https://github.com/pystardust/ytfzf
cd ytfzf
sudo make install doc
```
- If you wish to not install documentation (highly unrecommended) run `sudo make install` instead.
- If you wish to install addons, run `sudo make addons`
- `YTFZF_SYSTEM_ADDONS_DIR` will point to `/usr/local/share/ytfzf/addons` even if you set `PREFIX` to something else
- If you use a different prefix, it would be smart to export `YTFZF_SYSTEM_ADDONS_DIR` to `$PREFIX/share/ytfzf/addons` in a shell startup file.
- You may also install `ytfzf` through your package manager, as listed on the side.
## 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 ...`
To use a thumbnail-viewer addon run `ytfzf -T ...`
To use a interface addon run `ytfzf -i ...`
To use a url-handler addon run `ytfzf -u ...`
To use a sort-name addon run `ytfzf --sort-name= ...`
To use an extension addon run `ytfzf -e ...`
---
# Features
- Subscriptions
- Thumbnails
- Watch history
- Search History
- Downloading
- Queueing multiple videos
- Custom menus, and scrapers
- Addon support
---
# Examples
> Search with thumbnails
```sh
ytfzf -t
```
> Use `dmenu` as the menu instead of `fzf`
```sh
ytfzf -D
```
> Print the link of the selected video instead of playing it
```sh
ytfzf -L
```
> Search Odysee instead of youtube
```sh
ytfzf -cO
```
> 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
```sh
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](docs/conf.sh) (please dont use it)
For more information, see `ytfzf(5)` which should be installed, if it's not see [the wiki](https://github.com/pystardust/ytfzf/wiki).
---
# Bugs
- _dwm with swallow patch: Images don't render with ueberzug when looped (ie, option `-l`)_
- _if thumbnails are not working `.Xauthority` might be causing it. Try deleting it and relogging into your computer._
- When fzf is not set to 100% height, thumbnails may appear in the wrong position
# Contributing
Feel free to contribute, and add your name to the credits, please use the development branch. For more information see [contributing](CONTRIBUTING.md)
# Credits
| User | Contributions | Donate |
| :------------ | :---------------------------------------- | :----- |
| Pystardust | [contributions](credits/pystardust.md) | |
| Euro20179 | [contributions](credits/euro20179.md) | |
| Simonhughxyz | [contributions](credits/simonhughxyz.md) | |
| Jac-Zac | [contributions](credits/jac-zac.md) | |
| Mudskipper875 | [contributions](credits/mudskipper875.md) | |
| Gardockt | [contributions](credits/gardockt.md) | |
| qoheniac | [contributions](credits/qoheniac.md) | |
| mathisto | [contributions](credits/mathisto.md) | |