Skip to main content

Tidal in your terminal!

Project description

ttydal screenshot

ttydal - Tidal in your termial!

Static Badge

Inspiration

This project is heavily inspired by what Maxteabag have done on is awesome project sqlit.

Features

  • Browse your favorite albums, playlists, and tracks
  • Fuzzy search across all loaded albums and tracks (/ key)
  • High-quality audio playback with three quality levels:
    • Max: Hi-Res Lossless (up to 24bit/192kHz)
    • High: Lossless (16bit/44.1kHz)
    • Low: AAC 320kbps
  • Real-time stream quality verification showing actual bit depth and sample rate
  • Auto-play next track
  • Shuffle mode for randomized playback
  • Visual indicators showing currently playing track and source album/playlist
  • Playback controls with seeking support
  • Smart tracks caching for faster navigation and search
  • Player bar displaying track info, artist, album, playback time, and quality metrics
  • Multiple theme options for interface customization
  • Fully keyboard-driven interface
  • Settings auto-save on change
  • Cover art display in albums list, tracks list, and player bar
  • Image caching for cover art
  • Vibrant color mode - colorize player bar text with album's vibrant color
  • new Cache and config file are now stored in conventional directories for each platform

warning: this video contain audio of music, mind your volume

https://github.com/user-attachments/assets/ea975bea-b8f6-4d1a-a309-ec2d54390c3a

Requirements

  • Python 3.13 or higher
  • uv for development
  • Active Tidal subscription
  • MPV media player (for audio playback)

Installation

For users

# pipx (recommend)
pipx install ttydal

# uv
uv tool install ttydal

# pip
pip install ttydal

Then use it:

ttydal

For development

  1. Clone the repository:

    git clone https://github.com/results-may-vary-org/ttydal.git
    cd ttydal
    
  2. Install dependencies using uv:

    uv sync
    
  3. Run the application:

    uv run ttydal
    
  4. For development with auto-reload (optional):

    Install watchdog for automatic restart on file changes:

    uv add --dev watchdog
    

    Run with the development watcher:

    python dev.py
    

    This will automatically restart the application whenever you save changes to Python files.

Getting started

  1. Launch ttydal
  2. On first run, you'll see a login modal
  3. Press o to open the Tidal login URL in your browser
  4. Complete the authentication in your browser
  5. Press l to check login status
  6. Once logged in, your favorite albums, playlists, and tracks will load automatically

Keybindings

Navigation

Key Action
p Switch to Player page
c Switch to Config page
a Focus Albums/Playlists list
t Focus Tracks list
up/down Navigate through lists
enter Select item / Play track (always starts from beginning)
/ Open fuzzy search

Search Modal

Key Action
enter Navigate to selected album/track
space Play selected track (tracks only)
escape Close search

Playback Controls

Key Action
space Toggle play/pause (works anywhere on player page)
shift+left Seek backward 10 seconds
shift+right Seek forward 10 seconds
N (shift+n) Play next track
P (shift+p) Play previous track
n Toggle auto-play next track on/off
s Toggle shuffle mode on/off
r Refresh current list (also clears relevant cache)
i Open cache info modal
v Toggle vibrant mode

Login Modal

Key Action
o Open login URL in browser
c Copy login URL to clipboard
l Check login status
escape Close modal

Application

Key Action
q Quit application

Configuration

All settings are accessible via the Config page (press c).

Settings

  • Theme: choose from 12 built-in themes
  • Audio Quality: select default quality for your playback (max, high, or low)
  • Auto-Play: enable or disable automatic playback of next track
  • Shuffle: enable or disable shuffle mode
  • Debug Logging: enable or disable debug logging (debug.log in config directory)
  • API Logging: these logs can contains sensitive data enable or disable API request/response logging (debug-api.log in config directory)

All settings are automatically saved when changed.

Data directories

ttydal follows platform conventions for config and cache directories:

Type Linux MacOS Windows
Config & logs ~/.config/ttydal ~/Library/Application Support/ttydal %APPDATA%/ttydal
Image cache ~/.cache/ttydal/images ~/Library/Caches/ttydal/images %LOCALAPPDATA%/ttydal/images

Images cache

Loaded images are cached in the platform cache directory (see above).

Tracks cache

ttydal uses a caching system for tracks to improve performance and enable smart search.

How it works

  • In-memory cache: tracks are cached in memory (lost on app restart)
  • TTL of 1 hour: each cached album/playlist expires after 1 hour
  • Max 50,000 tracks: cache is limited by total track count, not album count.
  • LRU eviction: when cache is full, oldest entries are evicted first
  • Auto-preload: on startup, all albums are automatically preloaded into cache in the background (mostly for the search feature)

Cache info modal

Press i to open the cache info modal and see current cache statistics.

Cache invalidation

If you make changes to your playlists/favorites on the Tidal website:

  • Press r on Albums list that clears the entire tracks cache and reloads albums
  • Press r on Tracks list that invalidates only the current album/playlist cache and reloads

Code of conduct, license, authors, changelog, contributing

See the following file :

Want to participate? Have a bug or a request feature?

Do not hesitate to open a pr or an issue. I reply when I can.

This project is possible because another cool projects exist

Want to support my work?

Thanks !

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

ttydal-1.3.0.tar.gz (48.6 kB view details)

Uploaded Source

Built Distribution

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

ttydal-1.3.0-py3-none-any.whl (61.5 kB view details)

Uploaded Python 3

File details

Details for the file ttydal-1.3.0.tar.gz.

File metadata

  • Download URL: ttydal-1.3.0.tar.gz
  • Upload date:
  • Size: 48.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"EndeavourOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for ttydal-1.3.0.tar.gz
Algorithm Hash digest
SHA256 6ddf84970663592ec7da37a13a1ba60838d311c8a5b70c269bb563c83561c513
MD5 852bf44bc54d92315ded465172064a25
BLAKE2b-256 14eec01c2c853b24281740376ba934ead12a8afe2d143bdc9221d0dced184b75

See more details on using hashes here.

File details

Details for the file ttydal-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: ttydal-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 61.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"EndeavourOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for ttydal-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 686b0815135da39834cb03c195e8aa47c33f5e230eb665c8ba5492fd5605c55c
MD5 2a92b419feefead22b90f19386f7086e
BLAKE2b-256 bc92a61dc4b94c95063a84d938d5c296b1748e0bbae38f7cb6bc3ece3bf6cc6b

See more details on using hashes here.

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