Skip to main content

Tidekeeper

Tidekeeper

Tidekeeper is an unofficial maintained fork of yaronzz/Tidal-Media-Downloader, with a reliable terminal workflow and optional desktop GUI. The primary command is tidekeeper; tidal-dl remains available for compatibility.

CI Build PyPI Release License Python

Install

Tidekeeper requires Python 3.10 or newer.

ffmpeg is recommended for video downloads and optional FLAC remux (tidekeeper --doctor reports whether it is available).

python -m pip install -U tidekeeper
tidekeeper --help

Desktop GUI:

python -m pip install -U "tidekeeper[gui]"
tidekeeper-gui

From Git

python -m pip install -U "git+https://github.com/OpenNerdz/tidekeeper.git#subdirectory=TIDALDL-PY"
tidekeeper --help

One-line installer (Linux / Termux)

curl -fsSL https://raw.githubusercontent.com/OpenNerdz/tidekeeper/main/install.sh | bash

For Android shared storage, run termux-setup-storage and optionally set:

export TIDEKEEPER_DOWNLOAD_PATH="/storage/emulated/0/Download/Tidekeeper"

Prebuilt binaries

Terminal and desktop GUI executables for Windows, macOS, and Linux (x86-64 and ARM64) are attached to each GitHub Release.

Docker

Build the image from the repository, then persist account configuration and downloads with bind mounts. The image includes ffmpeg.

docker build -t tidekeeper .
docker run --rm -it \
  -v "$PWD/config:/config" \
  -v "$PWD/downloads:/downloads" \
  tidekeeper
docker run --rm \
  -v "$PWD/config:/config" \
  -v "$PWD/downloads:/downloads" \
  tidekeeper -l "https://tidal.com/browse/track/70973230"

The container runs as non-root UID 1000. Ensure both host directories are writable by that user. A GUI is not included in the container image.

Usage

tidekeeper --help
tidekeeper --doctor
tidekeeper --paths
tidekeeper --open-output
tidekeeper --update
tidekeeper -l "https://tidal.com/browse/track/70973230"
tidekeeper --video-only -l "https://tidal.com/browse/artist/123456"

Dolby Atmos downloads are opt-in with tidekeeper -q Atmos (or GUI audio quality Atmos). TIDAL keeps Atmos mixes on separate catalog IDs that often report quality LOW with an Atmos flag — search now labels those rows clearly, and when Atmos quality is selected Tidekeeper will switch a stereo album/track pick to the matching Atmos catalog release when one exists.

Failed downloads are saved to failed-tracks.txt in the download folder and can be retried with:

tidekeeper -l "/path/to/downloads/failed-tracks.txt"

URL lists accept comments starting with #, comma- or whitespace-separated URLs/IDs, and nested text files. Nested filenames resolve relative to the list containing them; repeated inputs and file cycles are skipped. The terminal continues past individual lookup failures and returns a failure status if any item failed.

TIDEKEEPER_DOWNLOAD_PATH sets the default download folder on every platform, including Docker. An existing saved profile keeps its configured folder.

Customizability

Custom filename formats are supported:

Tokens Description Album Track Video Playlist
{ArtistID} Comma separated list of each artists' ID for that media (i.e: 123, 456) ✅ ✅ ✅ ❌
{ArtistName} Comma separated list of each artists' name for that media (i.e: ABC, DEF) ✅ ❌ ❌ ❌
{ArtistName} Primary artist's name for that media ❌ ✅ ✅ ❌
{ArtistsName} Comma separated list of each artists' name for that media (i.e: ABC, DEF) ❌ ✅ ✅ ❌
{AlbumArtistID} Primary artist's ID for that media ✅ ❌ ❌ ❌
{AlbumArtistName} Primary artist's name for that media ✅ ❌ ❌ ❌
{TrackArtistID} Primary artist's ID for that media ❌ ✅ ❌ ❌
{TrackArtistName} Primary artist's name for that media ❌ ✅ ❌ ❌
{VideoArtistID} Primary artist's ID for that media ❌ ❌ ✅ ❌
{VideoArtistName} Primary artist's name for that media ❌ ❌ ✅ ❌
{Flag} Quality/content flags: M (Master), A (Dolby Atmos), E (Explicit) ✅ ❌ ❌ ❌
{AlbumID} ✅ ❌ ❌ ❌
{AlbumYear} ✅ ✅ ❌ ❌
{AlbumTitle} ✅ ✅ ❌ ❌
{AudioQuality} Audio quality reported by TIDAL (e.g. LOSSLESS, HI_RES) ✅ ✅ ❌ ❌
{DurationSeconds} ✅ ✅ ❌ ❌
{Duration} Duration formatted as MM:SS (or H:MM:SS) ✅ ✅ ❌ ❌
{NumberOfTracks} ✅ ❌ ❌ ❌
{NumberOfVideos} ✅ ❌ ❌ ❌
{NumberOfVolumes} ✅ ❌ ❌ ❌
{ReleaseDate} ✅ ❌ ❌ ❌
{RecordType} ✅ ❌ ❌ ❌
{TrackID} ❌ ✅ ❌ ❌
{TrackNumber} ❌ ✅ ❌ ❌
{TrackTitle} ❌ ✅ ❌ ❌
{ExplicitFlag} ❌ ✅ ✅ ❌
{StreamQuality} ❌ ✅ ❌ ❌
{Codec} ❌ ✅ ❌ ❌
{VideoID} ❌ ❌ ✅ ❌
{VideoNumber} ❌ ❌ ✅ ❌
{VideoTitle} ❌ ❌ ✅ ❌
{VideoYear} ❌ ❌ ✅ ❌
{PlaylistUUID} ❌ ❌ ❌ ✅
{PlaylistName} ❌ ❌ ❌ ✅

Desktop GUI

The GUI is a single workspace: find catalog items or paste links at the top, queue them, and run the queue below. Session and settings open in a side panel so the queue stays in view. After installing with the GUI extra above, launch it with tidekeeper-gui or tidekeeper --gui. Update GUI installs with tidekeeper --update-gui or the Update button in the Account panel.

Repeated additions reuse an unfinished queue job, including a pasted link to a catalog result already queued. Clear done removes completed rows; Undo restores the last removal. Retry incomplete retries failed, partial, interrupted, or cancelled jobs. Select a row to read its failure details.

Search can be cancelled while it runs. Settings mark unsaved changes; download options apply to the next run, and Save keeps them after restarting. Changing the TIDAL client requires saving and signing in again. Tables hide secondary columns when space is tight; title tooltips retain the additional information.

Shortcuts: Ctrl+F search, Enter on a result adds it to the queue, Delete removes queue rows, Ctrl+Z in the queue undoes removal, Ctrl+, opens Settings, and Esc closes the side panel.

Workspace: search, results and queue

Settings panel

Settings panel

Account panel

The lower Account panel keeps the scrollable Supporters list out of the main workspace.

Account panel with supporters

Troubleshooting

Run diagnostics first:

tidekeeper --doctor
tidekeeper --paths

For repeated HTTP 429 errors, keep Use request delay enabled and raise Request delay seconds to 30 or 60 before retrying.

If doctor warns that ffmpeg is missing, install it from your OS package manager (or use the Docker image). Video downloads and FLAC remux may otherwise be limited.

If Termux reports cannot locate symbol "x265_api_get_216", refresh its media packages with pkg upgrade -y && pkg reinstall -y ffmpeg x265. If that fails, change mirrors with termux-change-repo and retry.

Development

See CONTRIBUTING.md for setup and checks, CHANGELOG.md for release history, and SECURITY.md for private vulnerability reporting.

git clone https://github.com/OpenNerdz/tidekeeper.git
cd tidekeeper/TIDALDL-PY
python -m pip install -e .
python -m unittest discover -s tests

Build release artifacts with ./build.sh from the repository root.

Project policy

Tidekeeper does not aim to bypass access controls, subscription checks, or DRM. Use it only where permitted by law and applicable service terms. This project is not affiliated with or endorsed by TIDAL or Block, Inc.

The original project was created by YaronH and contributors. See NOTICE and LICENSE for attribution and licensing.

Release files for tidekeeper 2026.9.17.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tidekeeper 2026.9.17.0
File Size Uploaded
tidekeeper-2026.9.17.0.tar.gz 174.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tidekeeper 2026.9.17.0
File Interpreter ABI Platform
tidekeeper-2026.9.17.0-py3-none-any.whl Python 3 none any Details

Total release size: 323.9 kB

Release files / tidekeeper-2026.9.17.0.tar.gz

Download URL tidekeeper-2026.9.17.0.tar.gz
Size 174.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b8da04a023332bcc27fed5f1752959d1d2d8fa47d8e30d4251cc0541e0646510
BLAKE2b-256 checksum
How to use checksums
f42d5cd70e701d9186458698cc70e7e47668b666b2f8fe0f774c677dd34ab853
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / tidekeeper-2026.9.17.0-py3-none-any.whl

Download URL tidekeeper-2026.9.17.0-py3-none-any.whl
Size 149.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
254cf5e409a31bceea28ae6fcc63345e194c225e09f6ac9bb770940bfcd47a4d
BLAKE2b-256 checksum
How to use checksums
2afceabd866e477fbb59d7a0a599a36f82e6ba6f61bdbb3c96c5dce900058cc6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page