Skip to main content

YouTube Music CLI tool with interactive terminal interface

Project description

YTM - YouTube Music CLI

🎵 A simple, interactive command-line tool for YouTube Music

Stream music directly from YouTube Music in your terminal with intuitive controls, playlist management, and smart filtering.

YTM CLI Player

YTM CLI Lyrics

✨ Features

  • 🔍 Smart Search: Search and play any song from YouTube Music
  • 🎮 Interactive Controls: Play/pause, skip, go back with simple key presses
  • 📱 Vim-like Navigation: Use j/k keys or arrow keys to navigate
  • 📋 Local Playlists: Create and manage personal playlists
  • 👎 Smart Filtering: Dislike songs to filter them from future results
  • 📜 Synced Lyrics: Live-highlighted lyrics with auto-scroll (press l)
  • 🎯 Radio Mode: Automatic playlist generation based on your selection
  • 🤖 AI-Powered: Natural language music requests and AI-generated playlists

🚀 Quick Start

Requirements

Installation

One command with uv (recommended):

# Install from PyPI
uvx ytm-cli "song name"
Alternative: clone and run locally
git clone https://github.com/thieuluan1618/ytm.git
cd ytm
uv run ytm-cli "song name"
Alternative: one-shot setup scripts
git clone https://github.com/thieuluan1618/ytm.git
cd ytm

These create the virtual environment, install dependencies, and configure the ytm command globally.

Linux/macOS:

./setup.sh
source ~/.zshrc  # or ~/.bashrc for bash

Windows PowerShell:

.\setup.ps1
. $PROFILE

Windows Command Prompt:

setup.bat

After setup, use ytm (alias for ytm-cli) from anywhere.

Alternative: manual install
git clone https://github.com/thieuluan1618/ytm.git
cd ytm
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt
./setup_alias.sh          # or setup_alias.ps1 / setup_alias.bat

Basic Usage

Interactive search:

ytm-cli
# Enter search query when prompted

Direct search:

ytm-cli "your favorite song"

Non-interactive mode (automation/scripting):

ytm-cli search "song name" --select 1           # Auto-select first result
ytm-cli search "song" -s 1 -v                   # With verbose output
ytm-cli search "song" -s 1 -v --log-file debug.log  # Save debug logs

Tip: Set up the shell alias to use ytm as a shortcut for ytm-cli. See the setup scripts above.

🎮 Controls

During Song Selection

  • ↑/↓ or j/k - Navigate through results
  • Enter - Select and play song
  • q - Quit

During Playback

  • Space - Play/pause
  • n - Next song
  • b - Previous song
  • l - Show lyrics (synced highlighting with auto-scroll)
  • a - Add to playlist
  • d - Dislike song (skip and filter from future results)
  • q - Quit

During Lyrics View

  • j/k or ↑/↓ - Manual scroll
  • Space - Re-enable auto-scroll
  • q or Esc - Back to player
  • PgUp/PgDn - Page scroll
  • Home/End - Jump to top/bottom

📋 Playlist Management

Create and manage playlists:

ytm-cli playlist list              # List all playlists
ytm-cli playlist create            # Create new playlist
ytm-cli playlist show "My Songs"   # View playlist contents
ytm-cli playlist play "My Songs"   # Play entire playlist
ytm-cli playlist delete "My Songs" # Delete playlist

Add songs to playlists:

  • Press a during song selection or playback
  • Choose existing playlist or create new one
  • Song added without interrupting playback

🤖 AI Music Assistant

Use natural language to search and create playlists powered by AI (supports Google Gemini, OpenAI, Anthropic):

ytm-cli llm ask "play something chill for studying"       # AI picks and auto-plays
ytm-cli llm ask "upbeat pop songs for a workout"           # Natural language search
ytm-cli llm playlist "lo-fi beats for rainy days" --play   # AI-generated playlist
ytm-cli llm playlist "90s rock classics" -n 20             # 20-song playlist

Configure your provider in config.ini:

[llm]
provider = google       # google, openai, or anthropic
model = gemini-2.5-pro

🛠️ Configuration

The app uses config.ini for customization:

[general]
songs_to_display = 10
show_thumbnails = true

[mpv]
# Add custom mpv flags
flags = --no-video

[playlists]
directory = playlists

🎯 Philosophy

Keep it simple for the listener to enjoy music. Features are designed to be:

  • Intuitive: Single-key shortcuts during playback
  • Non-disruptive: Actions don't interrupt your listening experience
  • Consistent: Same navigation patterns across all screens
  • Quick: Important features accessible with simple key presses

🐛 Troubleshooting

Having issues? Check out the Troubleshooting Guide for solutions to common problems:

Quick diagnosis:

# Enable verbose logging to see what's happening
ytm-cli search "test" -s 1 -v --log-file debug.log

# Check versions
mpv --version
yt-dlp --version

📄 License

This project is open source. Please check the license file for details.


Enjoy your music! 🎵

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ytm_cli-0.7.1.tar.gz (74.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ytm_cli-0.7.1-py3-none-any.whl (53.7 kB view details)

Uploaded Python 3

File details

Details for the file ytm_cli-0.7.1.tar.gz.

File metadata

  • Download URL: ytm_cli-0.7.1.tar.gz
  • Upload date:
  • Size: 74.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ytm_cli-0.7.1.tar.gz
Algorithm Hash digest
SHA256 abcab9a9078a03bbddb1d5d9a65e89d6f7d3474a03a18b9f6e56d4fa6558a269
MD5 89379ffcde399f48b3c803f11da7b912
BLAKE2b-256 53eced5adc5d3d2c135e522e4532dd54d0aa385f0803ba3b052984807491ff62

See more details on using hashes here.

Provenance

The following attestation bundles were made for ytm_cli-0.7.1.tar.gz:

Publisher: publish.yml on thieuluan1618/ytm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ytm_cli-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: ytm_cli-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 53.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ytm_cli-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5a8d07b893bf24e2eaac595835fa65398c96cdcead9542da671b76fa926a0c45
MD5 485f3f6484bcf06e759a116d5350a109
BLAKE2b-256 fdd94f40ad1f6fb6dc6a48032e5ef46c90c4322c3f28ee035d9131811fc4fcab

See more details on using hashes here.

Provenance

The following attestation bundles were made for ytm_cli-0.7.1-py3-none-any.whl:

Publisher: publish.yml on thieuluan1618/ytm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page