Skip to content

Environment and home

The home directory

tunedex keeps everything it owns in one directory, its home:

Path What it holds
library.db The library: tracks, playlists, sources and history. A SQLite database.
snapshots/ One folder per target, with a snapshot taken before each apply. See Snapshots and restore.
rules.yaml Your rules, if you write one.
cache.db Fingerprints and answers from AcoustID and MusicBrainz, so that enrich does not ask twice. Safe to delete.

The home is chosen in this order:

  1. --home PATH, given before the command: tunedex --home /tmp/try scan ~/Music.
  2. The TUNEDEX_HOME environment variable.
  3. The per-OS default:
OS Default home
Linux $XDG_DATA_HOME/tunedex, else ~/.local/share/tunedex
macOS ~/Library/Application Support/tunedex
Windows %LOCALAPPDATA%\tunedex

Nothing is created until a plan is applied. Planning in a home that does not exist works on an empty library and leaves the disk untouched.

A scratch home is the easiest way to try tunedex without touching your real library:

export TUNEDEX_HOME=/tmp/tunedex-try
tunedex scan ~/Music --apply

Environment variables

Variable Effect
TUNEDEX_HOME The home directory, when --home is not given.
TUNEDEX_ACOUSTID_KEY The AcoustID application key enrich uses, instead of tunedex's own.
NO_COLOR Any non-empty value turns color off. Same as --no-color.
FORCE_COLOR Any non-empty value turns color on even when the output is not a terminal. NO_COLOR and --no-color win over it.

Color and progress never appear in --json output.