Skip to content
Documentation
Project

CLI — Commands

albums — List albums in the catalog

List albums in the catalog.

albums lists local releases/editions. Combine --artist, --year, --genre, --label, --comment and compilation filters with AND. --query keeps albums holding at least one matching track; an album annotation needs album.rating/album.tag in that expression. Sort by name/title, artist, year, tracks, duration/length or size.

This plural command takes no positional entity name. Use the singular/detail command to open one item rather than appending a name to the list. The displayed order is deterministic. Where pagination is offered, --offset counts skipped rows from zero, --limit must be positive and --all cannot be combined with --limit. CSV/JSON exports contain the filtered, paged result shown, not automatically the whole library. Add --all when supported for a complete export. The listing is read-only.

Syntax and arguments#

aede albums

No positional arguments. Use the filters listed below.

Options for this command#

OptionMeaning
--csvWrite a CSV table of this command’s result, suitable for a spreadsheet; mutually exclusive with other output formats.
--output FILE / -o FILEWrite an export to FILE instead of standard output. A selection needs --csv, --json or --m3u; command-specific exports have their own rules.
--compilationsList compilation albums only. Refused with --no-compilations.
--no-compilationsExclude compilation albums. Refused with --compilations.
--artist NAMEFilter by artist name on albums/track; on credit, name the credited person. Multiword names are accepted.
--year YYYYFilter albums by the specified release year; pass a numeric year, not a range. Use query for ranges.
--genre NAMEKeep albums matching this genre name. Use query to combine OR, exclusions or several criteria.
--label NAMEKeep albums matching this record-label name.
--comment TEXTFilter local file comment text. Comments are embedded metadata, distinct from personal notes.
--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.
--json / -jWrite this command’s structured JSON result. With analyze, save report files instead of changing terminal output.
--separator ";" / --separator tabWith --csv only: use comma by default, a one-character separator such as ;, or tab for tab-separated text. Quote ; in a shell.
--sort ORDERChoose a supported column; append - for descending order, for example duration-. Supported values for this command are listed below.
--query EXPRESSIONPass a relational query expression. Its projection depends on the command: save it, select tracks or retain matching albums/artists.

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 albums --artist "Miles Davis"
aede albums --year 1959 --all
aede albums --query "album.rating:>=4"
aede albums --csv --output albums.csv

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.

album, query.

Detailed existing guide: browsing.md.