Skip to content
Documentation
Project

User manual

Catalog and data safety

Understand releases, tracks, graph relationships, personal data and safe storage.

Aède catalogs local music; it does not track purchases or borrowed physical discs. Scanning reads files and tags but never rewrites the originals. Copy creates separate destination files; analysis, artwork, lyrics and playlists can create explicit sidecars beside music.

The graph vocabulary#

ObjectMeaningExample
Release / albumAn edition with track positions and local filesOne CD pressing of an album
Release groupThe shared album identity across editionsThe album before choosing a pressing
RecordingOne recorded performanceThe same performance on an original and compilation
TrackA recording’s placement in a releaseTrack 3 of disc 1
WorkA compositionThe work performed by different recordings
Artist / credit / relationPeople, their roles and attributed linksGuitarist, producer, composer, membership

Titles alone do not establish shared identities. MusicBrainz IDs and explicit relationships distinguish editions/performances and classical work parts. Copy the Open/Continue commands from entity pages when precision matters.

Four persistent stores#

FileContainsRecovery
catalog.jsonTag-derived graph and watched/excluded foldersRebuild by scan; roots must be supplied after reset
conclusions.jsonIntegrity, fingerprints, imported/derived analysesBack up; changed sources make old results stale
user.jsonNotes, stars, favorites, labels, history, collections and choicesIrreplaceable personal work; back up
sources.jsonAttributed external claims and review decisionsBack up; some facts can be fetched again

External facts stay beside local tags and carry provenance/confidence. A proposed or conflicting identity requires review before it becomes a trusted graph link. Your notes preserve their Markdown text; rendering belongs to a client, not a storage rewrite.

Folder access and consistency#

The music folder needs read access for scanning/playback. The Aède data folder needs read/write access for updates and must not be writable by unrelated users/groups when serving. A sidecar-writing command also needs write access at its output location. A server executes delegated writes with its account’s permissions.

Do not delete .aede.lock, hand-edit live JSON, or run old writers against a current server. All current writers share a data lock. On Unix the running server coordinates compatible CLI updates through its private socket; without it they run locally. Reads of an old snapshot do not mean an update was lost.

What a backup protects#

aede backup FILE saves the four readable stores in a versioned document, including personal history. It does not copy music, downloaded images, lyrics or playlists. Save those separately and keep an off-machine copy. export is for data inspection/sharing; rules is for reproducible choices; neither substitutes for a complete backup plus your original files.

Preserve the old data before an upgrade/restore. Rehearse restore into a separate empty --data folder. A restored catalog is a dated snapshot; a later scan reconciles actual files. See backup, restore, sources and review.