:help

Prints a possibly brief description of how to use the scraper.

-h, --help

Show help text.

--version

Show ytfzf's version.

-d, --download

Download the selected videos. This can also be set in the config file with is_download.

-m, --audio-only

Play audio only. This can also be set in the config file with is_audio_only.

-f, --formats

Show available formats before proceeding.

--format-selection=screen

The format selection screen type to use.

--format-sort=sort

The --format-sort to use in ytdl. This can also be set in the config file with format_selection_sort.

--video-pref=pref

Set the ytdl video format to pref. This can also be set in the config file with video_pref.

--audio-pref=pref

Set the ytdl audio format to pref. This can also be set in the config file with audio_pref.

--ytdl-pref=pref

Set the ytdl format to pref. This can also be set in the config file with ytdl_pref.

--detach

Detach the video player from the terminal. This can also be set in the config file with is_detach.

--url-handler=handler

The function/program to use as a url handler. This can also be set in the config file with url_handler.

-I option

Instead of playing the selected videos, get information about them in the selected format. The available options are:

-L

Alias for -I L

--info-action=Iaction

The action to do when --info-wait is 1. info_wait_action.

--info-wait=number

Whether or not to wait after printing info requested with -I or -L. This can also be set in the config file with info_wait.

-l, --loop

Reopen the menu when the video stops playing. This can also be set in the config file with is_loop.

-s, --search-again

After closing fzf make another search. This can also be set in the config file with search_again.

-t, --show-thumbnails

Show thumbnails. Doesn't work with -D or -H. This can also be set in the config file with show_thumbnails.

--skip-thumb-download

Whether or not to skip the thumbnail download. This is used if you want to not have thumbnails, or use custom thumbnails in $YTFZF_CUSTOM_THUMBNAILS_DIR.
For more info see CUSTOM THUMBNAILS in ytfzf(5)
This can also be set in the config file with skip_thumb_download.

--notify-playing

Show notifications when a video is about to be played. This can also be set in the config file with notify_playing.

--preview-side=side

The preview side in fzf.
Options:

This can also be changed in the config file with fzf_preview_side.

--thumb-viewer=program

Use program for displaying thumbnails.
Built-in programs:

This can also be changed in the config file with thumbnail_viewer.

-D, --external-menu

Use an external menu instead of fzf. The default is dmenu. This can also be set in the config file with interface="ext".

--interface=interface

Use a custom interface script, which would be in $YTFZF_CUSTOM_INTERFACES_DIR. This can also be set in the config file with interface.

--sort

Sorts videos (after scraping) by upload date.

--sort-name=name

Calls a function set in $YTFZF_CONFIG_FILE. Or sources a script in $YTFZF_SORT_NAMES_DIR (if it exists). See SORT NAMES in ytfzf(5) for more information.

--fancy-subs

Whether or not to have a separator between each subscription. When this option is used it automatically disbables --sort as it will mess up this option.
This can also be set in the config file with fancy_subs.

--disable-back

Whether or not to disable the back button in submenus.
This can also be set in the config file with enable_back_button.

--disable-submenus

Whether or not to disable submenus.
Submenus are the menus that happen after a playlist or channel (currently only supported by youtube/invidious) is selected
This can also be set in the config file with enable_submenus.

--submenu-opts=opts

The opts to use in the submenu.
This can also be set in the config file with submenu_opts.

--submenu-scraping-opts=opts

The opts to use for scraping in the submenu.
This can also be set in the config file with submenu_scraping_opts.

-a, --auto-select

Auto-play the first result.

-A, --select-all

Select all results.

-r, --random-select

Auto-play a random result.

-S sed address, --select=sed address

Auto-play a specific video.

-n number, --link-count=number

The number of videos to select with -a or -r.

-c scrapers, --scrape=scrapers

Set which scraper to use. Multiple scrapers can be separated by comma (,). The currently supported builtin scrapers are:

-H, --history

Alias for -c H.
Scrapes history file.

--scrape+=scrapers

Same as -c, but keeps the default scrape as well.

--scraper-=scrapers

Removes scraper from list of scrapers to use

--multi-search

Whether or not to use multi search.
To use multi search, separate each search with a comma, this works well when using multiple scrapers.
This can also be set in the config file with multi_search.

--force-youtube

When using the youtube scraper, convert the invidious links to youtube links before playing/downloading.

Currently, --video-duration, --type, --thumbnail-quality, and --features only applies to the scrape: youtube/Y

--pages=amount

Amount of pages to scrape on youtube/invidious, and the comments scraper. This can also be set in the config file with pages_to_scrape.

--max-threads=amount

Amount of threads that can be used to scrape youtube search, playlists, and channels. (this does not apply to the subscription scraper).
This can also be set in the config file with max_thread_count.

--single-threaded

Set the max_thread_count to 1, this has the same effect as making everything single threaded. (this does not apply to the subscription scraper).
This can also bet set in the config file with max_thread_count=1.

--odysee-video-count=amount

Amount of videos to scrape on odysee. This can also be set in the config file with odysee_video_search_count.

--nsfw

Whether or not to search for nsfw videos.
Only works with odysee/O This can also be set in the config file with nsfw.

--sort-by=sort

Works with youtube/Y and odysee/O.
To use a different sort for each scrape, use comma (,) to separate the sorts.
As apposed to --sort, this happens during the search, not after. Results should sort by:

--upload-date=time-frame

Works with youtube/Y and odysee/O
To use a different sort for each scrape, use comma (,) to separate the dates.
Search for videos within the last:

--video-duration=duration

Whether or not to search for long or short videos. Possible options:

--type=type

The type of results to get.

--thumbnail-quality=quality

Select the quality of the thumbnails. Available options:

--features=features

The features to have on a video (comma separated).

--region

The region (country code) to search.
Supported by the scrapes youtube/Y and youtube-trending/T

--channel-link=link

Converts channel links from 'https://youtube.com/c/name' to 'https://youtube.com/channel/id'

-q

Use search history instead of a search. This can also be set in the config file with use_search_hist.

-x, --history-clear=<search|watch>

Clear search and watch history (if -x or --history-clear is used)
To specify either search or watch history use --history-clear=<search|watch>

--keep-cache

Whether or not to keep cache after ytfzf exists. This can also be set in the config file with keep_cache.

--ytdl-opts=option

Pass command-line options to youtube-dl when downloading.

example: --ytdl-opts='-o ~/Videos/%(title)s.%(ext)s'
    

--ytdl-path=path

Specify the path to youtube-dl or a fork of youtube-dl for downloading.
This can also be set in the config file with ytdl_path.

--ext=extension

Load an extension.
You may also add load_extension extension to your config file.

--list-addons

Lists all addons and exits.

$cache_dir
| -- watch_hist
| -- <search>-<pid>
|  | -- post-scrape
|  | -- <submenu-search>-<submenu-pid>?
|  | -- thumbnails?
|  | -- tmp
|  |  | -- curl_config
|  |  | -- <scrape>.html
|  |  | -- <scrape>.json
|  |  | -- menu_keypress
|  |  | -- submenu.json?
|  | -- ids
|  | -- videos_json

watch_hist

The watch history file.

<search>-<pid>

An instance's parent folder.
If no search was given it uses the name "SCRAPE-<scrape>-<pid>" instead.

post-scrape

A folder that contains files relating to the scraping of a selected result.

<submenu-search>-<submenu-pid>

Created when a submenu is opened (eg: when a channel/playlist is selected).

submenu

The folder to hold information about the submenu, all subitems are the same as the parent equivelent.

thumbnails

Stores the thumbnails for the instance (only with -t).

tmp

Stores less importatnt temporarily used files.

curl_config

The configuration file for curl for downloading thumbnails (only with -t).

<scrape>.html

For scrapers that need to scrape websites, this is the output of curl.

<scrape>.json

The json scraped from a website.

menu_keypress

The key pressed in fzf.

submenu.json

A temp json file used to store the video_json of links to be put into the submenu.

ids

The file that stores the id of each selected video.

videos_json

The file that stores a json of all videos displayed in fzf.
This file is very helpful for making playlists as it is in the same format.