Skip to main content

YouTube in Terminal - Fire-and-Forget Music CLI

Project description

Yit (YouTube in Terminal) Player 🎵

PyPI version License: MIT Python 3.7+

The Fire-and-Forget Music Player for Developers.

Yit (YouTube in Terminal) is a lightweight, headless, terminal-based audio player designed for flow states. It allows you to search, queue, and control music directly from your CLI without ever touching a browser or a heavy GUI.

It runs in the background (daemonized), meaning you can close your terminal, switch tabs, or keep coding while the music plays.


🚀 Features

  • Daemon Architecture: The player runs as a detached background process. Your terminal is never blocked.
  • Instant Search: Uses yt-dlp to fetch metadata in milliseconds.
  • Smart Queue: Manage your playlist (add, next, back, Loop) with simple commands.
  • Cross-Platform: Works natively on Windows, macOS, and Linux.
  • Agent-Native: Built from the ground up to be controlled by AI Agents (Vibe Coding).

📦 Installation

pip install yit-player

Requirements

  • None! Yit automatically manages the mpv audio engine internally.
  • Windows: Auto-downloads a portable mpv.exe if missing.
  • Mac/Linux: Uses system MPV (install via brew or apt if needed).

Troubleshooting: "Command not found"

If you run yit and get an error, your Python scripts folder is not in your system PATH. Solution: Run it like this instead (works 100% of the time):

python -m yit search "lofi" -p

⚡ Quick Start

1. Search & Play

# Search for a song
yit search "lofi hip hop"

# Auto-play the first result immediately
yit search "daft punk" -p

2. Control Playback

yit pause    # (or 'p')
yit resume   # (or 'r')
yit toggle   # Toggle play/pause
yit stop     # Kill the player

3. Queue Management

yit add 1    # Add result #1 from your last search to the queue (use 1 - 5 to choose from search results)
yit queue    # Show the current queue
yit next     # Skip track (or 'n')
yit back     # Previous track (or 'b')
yit clear    # Wipe the queue

4. Looping

yit loop     # Loop the current track indefinitely
yit unloop   # Return to normal playback

5. Status

yit status   # Check if currently Playing/Paused and Looped

🤖 For AI Agents & Vibe Coding

Yit is designed to be self-documenting for AI context. If you are building an AI agent or using an LLM in your IDE:

  1. Read context: Point your agent to AI_INSTRUCTIONS.md (included in the repo).
  2. Discovery: Run yit commands to get a JSON list of all capabilities.
  3. State: Run yit agent to get the full player state (Track, Time, Queue) in pure JSON.

Example Agent Output (yit agent):

{
  "status": "playing",
  "track": {
    "title": "Never Gonna Give You Up",
    "url": "https://..."
  },
  "position": 45.2,
  "duration": 212.0,
  "queue_length": 5
}

🛠️ Architecture

  • Client: Python CLI (yit) handles argument parsing and user signals.
  • Daemon: A detached mpv process handles audio decoding and network streaming.
  • Communication: IPC (Inter-Process Communication) via Named Pipes (Windows) or Unix Sockets (Linux/Mac).
  • Persistence: ~/.yit/history.json stores your playback history and queue metadata.

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

yit_player-0.1.7.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

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

yit_player-0.1.7-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file yit_player-0.1.7.tar.gz.

File metadata

  • Download URL: yit_player-0.1.7.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for yit_player-0.1.7.tar.gz
Algorithm Hash digest
SHA256 c4a1758497ebfdf3ab1e3d8976500746992cf030142e2e9ed55b9a7765bccf4a
MD5 cadb6f257eb04cd6a830c8e81a81bc5a
BLAKE2b-256 528ef5b49460776d570c58bfa31b57b9af316fd8e2741d2b5653c011aa8a614d

See more details on using hashes here.

Provenance

The following attestation bundles were made for yit_player-0.1.7.tar.gz:

Publisher: publish.yml on VijayarajParamasivam/yit

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

File details

Details for the file yit_player-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: yit_player-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 11.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for yit_player-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8f25a97c37a46d1860fd91d4cd57d30f3240df0d230d78413d637dd8887e1bec
MD5 da5ddb85d1e6f522d3feded2081fa054
BLAKE2b-256 43c7ddc852d0e4631f6e7bfa2dddbf8c8af56aead6b15b8a1a6aae3ef118ae85

See more details on using hashes here.

Provenance

The following attestation bundles were made for yit_player-0.1.7-py3-none-any.whl:

Publisher: publish.yml on VijayarajParamasivam/yit

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