Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://siriusmart.github.io/youtube-tui/
An aesthetically pleasing YouTube TUI written in Rust
https://siriusmart.github.io/youtube-tui/
cli rust rust-lang terminal terminal-based terminal-user-interface tui youtube youtube-dl
Last synced: about 1 month ago
JSON representation
An aesthetically pleasing YouTube TUI written in Rust
- Host: GitHub
- URL: https://siriusmart.github.io/youtube-tui/
- Owner: Siriusmart
- License: gpl-3.0
- Created: 2022-04-28T19:19:51.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-11T20:12:46.000Z (4 months ago)
- Last Synced: 2024-04-12T12:09:55.517Z (2 months ago)
- Topics: cli, rust, rust-lang, terminal, terminal-based, terminal-user-interface, tui, youtube, youtube-dl
- Language: Rust
- Homepage: https://siriusmart.github.io/youtube-tui
- Size: 3.66 MB
- Stars: 209
- Watchers: 8
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- cli-apps - YouTube TUI - A lightweight and user-friendly TUI for browsing YouTube content from the terminal. (<a name="video"></a>Video)
- awesome-cli-apps - YouTube TUI - A lightweight and user-friendly TUI for browsing YouTube content from the terminal. (<a name="video"></a>Video)
README
[](https://crates.io/crates/youtube-tui)
[](https://crates.io/crates/youtube-tui)
[](https://aur.archlinux.org/packages/youtube-tui)
***Read more in the [user manual](https://siriusmart.github.io/youtube-tui) (including installation guide and documentation).***
# Overview
Written in Rust, the **YouTube TUI** is a lightweight and user friendly TUI for browsing YouTube content from the terminal. Works out of the box and easily to configurable.
It is like an _app launcher_, it launches other programs to do the heavy lifting (for example, `mpv` for playing videos).
It also have an embedded mpv music player, but that can be disabled in compile time.
> Consider regenerating config files on updates to allow new features.
## Customisable
The YouTube TUI can be customised through config files, they are located in `~/.config/youtube-tui` and are in the YAML format.
Here's an example of the config file:
```yaml
mouse_support: true
invidious_instance: https://vid.puffyan.us
max_watch_history: 50
allow_unicode: false
images: Sixels
refresh_after_modifying_search_filters: true
provider: YouTube
env:
browser: firefox
video-player: mpv
youtube-downloader: yt-dlp
terminal-emulator: konsole -e
```
Anything from layouts to colours and keybindings can be customised, more on that later.
## Dependency-free*
See [installation#features](https://siriusmart.github.io/youtube-tui/installation.html#features) for more info on dependencies.
The YouTube TUI does not work on its own, it is instead like a _TUI frontend_ for programs like `mpv` or `yt-dlp`/`youtube-dl`.
However, the programs to launch can be changed, and therefore the YouTube TUI does not rely on any specific dependencies to run.
## Powerful
The YouTube TUI allows you to browse YouTube with (almost) all of it's features, functions including:
- View information about channels, playlists and videos
- Use search filters to sort and filter search results
- Save browsing history
- Embedded audio/music player
It also includes features like:
- Vim-like commands
- Mouse support
- Extensible keybindings system
- Offline library
- Subscriptions
### What it doesn't have
- [URGENT] Replace the no-longer-going-to-compile `typemap` dependency with either a self implementation of it or a useable crate.
- Strip down some libraries to reduce compile speed.
- Add command section for channel main page (first priority)
- Git like command line to improve on `yt-dlp` - make changes to existing downloaded playlists instead of redownloading the entire thing.
## How to contribute
You will need a general knowledge of the Rust programming language, and the ability to _understand my spaghetti_.
1. Open an issue to make sure nobody else is working on the same feature
2. Write code
3. Open a pull request
4. Get merged?
Or just _fix that typo in README_ -\_-