yt-collate

yt-collate is an efficient Terminal User Interface (TUI) client for YouTube Music, designed to enhance user experience by focusing on efficiency and ease-of-use while providing a comprehensive feature set. This project originated from a personal passion to create a fully-equipped YouTube Music client that incorporates all desired functionalities.

Key Features

• Minimalist Design: Enjoy a clean and modern TUI layout tailored for YouTube Music.
• Fast and Lightweight: Experience quick response times and low resource usage.
• User Authentication: Access personal libraries and receive tailored recommendations securely.
• Comprehensive Navigation: Explore YouTube Music's Home, Explore, Search, and Trending pages with ease.
• Dynamic Playback: Enjoy a seamless playback experience with an intuitive queue management system.
• Download Functionality: Effortlessly download tracks or playlists for offline listening.
• Intuitive Keybindings: Navigate efficiently with a vast array of keybindings, including n for the next track and d for downloads.
• Library Management: Simplify library tasks with operations such as creating playlists (o) and deleting songs or playlists (x).
• Playlist Features: Easily add songs to collections from anywhere using playlist markers.
• Enhanced Audio Quality: Subscribers to YouTube Music can leverage enhanced audio bitrate for both streaming and downloads.
• Discord Rich Presence: Share your current listening activity on Discord.

Unique Functionalities

• Utilizes Vim's conventions for song management with x (cut), y (yank), and p (paste).
• Jump through the track with 0-9 keys, mirroring YouTube's playback keys for quick navigation.
• An audio bitrate indicator verifies any enhancements available for premium users.
• Supports a local filter feature for rapid access and navigation.
• The search function accommodates YouTube URLs, making exploration more convenient.
• Offers an option to hide unwieldy "Episodes for Later" items in the Library for better organization.
• Employs a reshuffling mechanism that refreshes the queue without implementing an "unshuffle" option.

Prerequisites

• Python 3.12+
• mpv
• yt-dlp (nightly build)
• A JavaScript runtime such as Deno, Node, or QuickJS for reliable fetching operations.

Usage Instructions

To authenticate and set up, run:

yt-collate auth

Follow the on-screen prompts to create authentication credentials. Start collate with:

yt-collate

Refer to the in-app help by pressing ? to view all keybindings for navigation.

Data and downloaded media are stored under ~/.config/yt-collate/ and ~/Music/yt-collate, respectively.

For development contributions, consider enhancing the genre list in src/services/random_song.py. Testing and linting can be executed through:

uv run pytest # for testing
uv run ruff check . # for linting/formatting

With its robust features and user-centric design, yt-collate provides an optimized way to enjoy YouTube Music through the terminal.