yt-dlp-termux-gui 1.2.12

Simple yet useful Termux GUI for yt-dlp.

Simple yet useful Termux GUI for yt-dlp.

Watch the GUI in action

Why create this?

To answser the question:

"Why not use Seal, YTDLnis or yt-dlp directly in Termux instead?"

This tool was created due to limitations of existing yt-dlp Android APK wrappers (eg. Seal, YTDLnis), where yt-dlp would failing to download videos from websites with heavy bot protection.

On Termux even after installing yt-dlp with pip install yt-dlp[default,curl_cffi] on Android, curl_cffi would still not recognize the curl-impersonate binaries.

That limitation would cause:

• curl_cffi not being able to find the correct curl-impersonate binaries.
• downloading videos from websites with bot protection would typically fail with a 403 error.

Caveats

• The GUI is lightweight with only a subset of features.
• The curl-impersonate binaries only works with chrome impersonation at the moment (others haven't been tested).
• The GUI is not optimized for concurrent downloads.

Installation

Prerequisites

These must be installed before using yt-dlp-termux-gui:

• Termux
• Termux:Widget Plugin
• Termux:GUI Plugin

Install using pip

pip install yt-dlp-termux-gui --upgrade

How to use (declarative)

check if required dependencies are installed

import yt_dlp_termux_gui

# force=True -> Overwrite 'curl-impersonate' compiled binaries if they already exist
yt_dlp_termux_gui.ensure_packages(force=True)

create Termux:Widget shortcut (optional)

# task=True -> Make the widget a Termux:Widget task to allow it to run in the background
#
# WARNING:
# the plugins 'Termux:GUI' and 'Termux:Widget'
# must be installed the same way as Termux was installed
# Termux:GUI --> https://github.com/termux/termux-gui
# Termux:Widget --> https://github.com/termux/termux-widget
yt_dlp_termux_gui.ensure_termux_widget(force=True, task=True)

launch the GUI

# launch the GUI
yt_dlp_termux_gui.launch()

manage settings

# get settings
settings = yt_dlp_termux_gui.get_settings()

# reset settings
yt_dlp_termux_gui.reset_settings()

# get settings file path (~/.config/yt_dlp_termux_gui/settings.json)
settings_path = yt_dlp_termux_gui.SETTINGS_PATH

get widget information

# get widget name (yt-dlp-gui.sh)
widget_name = yt_dlp_termux_gui.WIDGET_SCRIPT_NAME

# get widget title (YT-DLP TERMUX GUI)
widget_title = yt_dlp_termux_gui.WIDGET_TITLE

How to use (CLI)

Usage: yt-dlp-termux-gui [OPTIONS...] [COMMAND]

Commands:
deps --> Ensure dependencies (install missing packages)
launch --> Launch the GUI
widget --> Ensure Termux:Widget shortcut for the GUI

Options:
--verbose <silent|debug|info|warning|error|critical> --> Set logging level
--silent --> Disable ALL GUI logs in Termux
--widget-name --> Print widget name
--widget-script-name --> Print widget script filename
--settings --> Print current settings
--settings-path --> Print settings path
--settings-reset --> Reset settings
-h, --help --> Show this help message
-v, -V, --version --> Print version

Options [deps]:
--force --> Overwrite 'curl-impersonate' compiled binaries if they already exist

Options [launch]:
--no-activity-logs --> Disable GUI activity logs in Termux
--init-logs --> Enable GUI initialization logs in Termux by the GUI

Options [widget]:
--force --> Overwrite existing widget if it already exist
--task --> Make the widget a Termux:Widget task to allow it to run in the background

Tools

Terminal

• Termux
  • Termux:Widget Plugin
  • Termux:GUI Plugin

CLI

• yt-dlp
• termux-api
• termuxgui

Binaries

• curl_cffi
• curl-impersonate-android