Skip to content
Documentation
Project

CLI — Commands

import — Import acoustic analyses from FlacCompagnon

Import acoustic analyses from FlacCompagnon.

import reads FlacCompagnon JSON reports, including reports saved at artist level covering several albums. It can precede the first scan: measurements attach by file path and wait until matching music is catalogued. The command does not perform a new acoustic analysis or contact the network.

--list shows attached, waiting and stale results. --pending narrows to results whose file is not yet catalogued. --forget removes the selected stored analyses; with --pending it removes only waiting results. Folder arguments narrow --list, --pending and --forget --pending; bare --forget refuses a folder argument. Ordinary import accepts report files or recursively walked report directories. --source narrows by tool name.

--limit, --offset and --all apply only to read-only --list/--pending output; importing or forgetting refuses them. --forget cannot be combined with --list. --source filters stored listings/removal and is refused when importing report files. These mode checks precede reading or publishing stores.

The newer available report date wins for overlapping file results, including waiting reports attached after a scan. Changing source audio makes old measurements stale. Deleting a report later does not remove imported data. A malformed JSON file, invalid report envelope, unsupported version or unreadable path is reported rather than treated as audio. A report requires a report object and a files array; an empty array remains valid. Legacy reports without a version retain version 0 compatibility, while a present version must be an unsigned 32-bit integer. Use analyze when you want fresh in-process measurements.

Syntax and arguments#

aede import <report…>

Ordinary mode: JSON reports or report directories walked recursively. List/pending/removal-of-pending: optional folders; bare --forget takes no folder.

Options for this command#

OptionMeaning
--forgetRemove stored data/decisions in this command’s scope. It does not delete audio or retag files.
--pendingRestrict imported analyses to results waiting for a matching scanned file. With --forget, remove only those waiting results.
--listList the individual stored records or decisions instead of the normal summary/operation.
--source NAMEFilter by the stored source/tool name. Use the names printed by the corresponding listing.
--limit NShow at most N rows; use a positive whole number. Default limits depend on the page, usually 50.
--offset NSkip N rows before showing the result; N starts at 0. Ordering remains deterministic.
--allShow every row. Refused with --limit. Some commands also use it to include normally hidden categories, explained below.

The shared options reference explains --data, --no-color, --help/-h, --version/-v/-V, option values and output/pagination rules. These shared presentation/data options do not make every command support CSV/JSON or pagination.

Examples#

aede import "/path/to/artist-report.json"
aede import --list --all
aede import --pending
aede import --forget --pending

Result and errors#

Output describes the selected operation or catalog data. Read any per-item warnings and retained-work summary; a completed process is not an independent integrity or audio-quality guarantee. Invalid command syntax/options normally exit with code 2; handler failures normally exit with code 1. Local interruption differs from a delegated server task, as explained in cancel.

analyze, scan, track.

Detailed existing guide: imported-analyses.md.