lists
Enumerate every deck, collection, and wanted list — the discovery counterpart to the list management commands (new, rename, delete) and a quick way for scripts to learn what exists before targeting a list by name.
./ritual lists [options]Options
Section titled “Options”| Option | Description | Default |
|---|---|---|
--deck | Only list decks | |
--collection | Only list collections | |
--wanted | Only list wanted lists | |
--output <format> | Output format: text, json, or ndjson | text |
--quiet | Suppress non-essential output | false |
The three type flags are mutually exclusive; passing more than one is a usage error.
Examples
Section titled “Examples”List everything:
./ritual listsdeck burn Burndeck stax Winota Staxcollection main Main Binderwanted needs NeedsEach text row is three aligned columns: the list type, the slug (the file basename, which is what other commands resolve), and the display name (a deck’s front-matter name, a flat list’s # H1).
Only decks, as JSON:
./ritual lists --deck --output json[ { "type": "deck", "slug": "burn", "name": "Burn" }, { "type": "deck", "slug": "stax", "name": "Winota Stax" }]ndjson emits the same rows one JSON object per line.
Behavior
Section titled “Behavior”Rows are sorted by type (decks, then collections, then wanted lists), then by slug. When nothing matches, the command still exits 0: text output prints (no lists), JSON output prints [], and NDJSON prints nothing.
Exit Codes
Section titled “Exit Codes”| Code | Meaning |
|---|---|
0 | Success (including an empty result) |
2 | Usage error (more than one type flag) |
1 | Runtime error |