Hello! # Command-Line Help for `listenbrainz-cli-tools` This document contains the help content for the `listenbrainz-cli-tools` command-line program. **Command Overview:** * [`listenbrainz-cli-tools`↴](#listenbrainz-cli-tools) * [`listenbrainz-cli-tools cache`↴](#listenbrainz-cli-tools-cache) * [`listenbrainz-cli-tools cache load-dump`↴](#listenbrainz-cli-tools-cache-load-dump) * [`listenbrainz-cli-tools cache clear`↴](#listenbrainz-cli-tools-cache-clear) * [`listenbrainz-cli-tools compatibility`↴](#listenbrainz-cli-tools-compatibility) * [`listenbrainz-cli-tools config`↴](#listenbrainz-cli-tools-config) * [`listenbrainz-cli-tools config blacklist-mapper-msid`↴](#listenbrainz-cli-tools-config-blacklist-mapper-msid) * [`listenbrainz-cli-tools config set-token`↴](#listenbrainz-cli-tools-config-set-token) * [`listenbrainz-cli-tools config timeout`↴](#listenbrainz-cli-tools-config-timeout) * [`listenbrainz-cli-tools config listens`↴](#listenbrainz-cli-tools-config-listens) * [`listenbrainz-cli-tools config listens refresh-unmapped-listens`↴](#listenbrainz-cli-tools-config-listens-refresh-unmapped-listens) * [`listenbrainz-cli-tools lookup`↴](#listenbrainz-cli-tools-lookup) * [`listenbrainz-cli-tools mapping`↴](#listenbrainz-cli-tools-mapping) * [`listenbrainz-cli-tools mapping list-unmapped`↴](#listenbrainz-cli-tools-mapping-list-unmapped) * [`listenbrainz-cli-tools mapping mapper`↴](#listenbrainz-cli-tools-mapping-mapper) * [`listenbrainz-cli-tools radio`↴](#listenbrainz-cli-tools-radio) * [`listenbrainz-cli-tools radio circles`↴](#listenbrainz-cli-tools-radio-circles) * [`listenbrainz-cli-tools radio underrated`↴](#listenbrainz-cli-tools-radio-underrated) * [`listenbrainz-cli-tools radio rate`↴](#listenbrainz-cli-tools-radio-rate) * [`listenbrainz-cli-tools radio overdue`↴](#listenbrainz-cli-tools-radio-overdue) * [`listenbrainz-cli-tools stats`↴](#listenbrainz-cli-tools-stats) ## `listenbrainz-cli-tools` A CLI app containing a set of useful tools for Listenbrainz **Usage:** `listenbrainz-cli-tools ` ###### **Subcommands:** * `cache` — Commands to deal with the local cache * `compatibility` — * `config` — Commands to deal with the app's configuration * `lookup` — Get detailled information about an entity * `mapping` — Commands for interacting with listen mappings * `radio` — Generate radio playlists for you * `stats` — Shows top statistics for a specific target ## `listenbrainz-cli-tools cache` Commands to deal with the local cache **Usage:** `listenbrainz-cli-tools cache ` ###### **Subcommands:** * `load-dump` — Load a listen dump from the website * `clear` — Wipe the cache's data ## `listenbrainz-cli-tools cache load-dump` Load a listen dump from the website Allows to load an exported dump of you listens. This is often faster than using the app. This also prevent stumbling into LB-1584 You can get a listen dump [here](https://listenbrainz.org/settings/export/) **Usage:** `listenbrainz-cli-tools cache load-dump ` ###### **Arguments:** * `` — Name of the user to import those listens for * `` — Path to the dump file ## `listenbrainz-cli-tools cache clear` Wipe the cache's data This is useful if you need disk space, or need to manually rebuild in case of corruption **Usage:** `listenbrainz-cli-tools cache clear ` ###### **Arguments:** * `` Possible values: `all` ## `listenbrainz-cli-tools compatibility` **Usage:** `listenbrainz-cli-tools compatibility ` ###### **Arguments:** * `` — The name of the first user * `` — The name of the second user ## `listenbrainz-cli-tools config` Commands to deal with the app's configuration **Usage:** `listenbrainz-cli-tools config ` ###### **Subcommands:** * `blacklist-mapper-msid` — Prevent an MSID to appear in the mbid mapper * `set-token` — Associate an user token to an username. This makes `--token` arguments optional, and prevent always having to insert it * `timeout` — Prevent the recording to appear on radios for a while. If you're burn out of a track and need it gone, use this * `listens` — Configuration targeting listen data ## `listenbrainz-cli-tools config blacklist-mapper-msid` Prevent an MSID to appear in the mbid mapper **Usage:** `listenbrainz-cli-tools config blacklist-mapper-msid [OPTIONS] ` ###### **Arguments:** * `` — The msid to blacklist ###### **Options:** * `--remove` — Remove it from the blacklist ## `listenbrainz-cli-tools config set-token` Associate an user token to an username. This makes `--token` arguments optional, and prevent always having to insert it **Usage:** `listenbrainz-cli-tools config set-token ` ###### **Arguments:** * `` — Name of the user to add the token * `` — User token ## `listenbrainz-cli-tools config timeout` Prevent the recording to appear on radios for a while. If you're burn out of a track and need it gone, use this **Usage:** `listenbrainz-cli-tools config timeout ` ###### **Arguments:** * `` — A string containing a MBID of a recording * `` — A duration to timeout for ## `listenbrainz-cli-tools config listens` Configuration targeting listen data **Usage:** `listenbrainz-cli-tools config listens ` ###### **Subcommands:** * `refresh-unmapped-listens` — Toggle / Set whether the unmapped listens should be automatically updated when fetching listens ## `listenbrainz-cli-tools config listens refresh-unmapped-listens` Toggle / Set whether the unmapped listens should be automatically updated when fetching listens **Usage:** `listenbrainz-cli-tools config listens refresh-unmapped-listens ` ###### **Arguments:** * `` — What do you want it set to? Possible values: `toggle`, `true`, `false` ## `listenbrainz-cli-tools lookup` Get detailled information about an entity **Usage:** `listenbrainz-cli-tools lookup ` ###### **Arguments:** * `` — Name of the user to look up stats from * `` — The type of entity to look for Possible values: `recording` * `` — The id of the entity (Accept URLs) ## `listenbrainz-cli-tools mapping` Commands for interacting with listen mappings **Usage:** `listenbrainz-cli-tools mapping ` ###### **Subcommands:** * `list-unmapped` — List all of your unlinked listens * `mapper` — Easy and faster mapping of recordings ## `listenbrainz-cli-tools mapping list-unmapped` List all of your unlinked listens This command will list all your unmapped listens, grouped by similarity. It also gives a link to quickly look up the listen in listenbrainz, and go link it ```text (1) Paul's Dream (Dune) - Caster -> (7) Raise Your Weapon - KLOUD -> Total: 8 unlinked recordings ``` > Note: Listens are grouped by "Messybrainz ID" (MSID). This is the way Listenbrainz recognize similar listens by attributing them the same MSID. Linking a listen will link the others as long as they have the same MSID. > This also means that the same recording can be shown twice in the list. For example: "Panic - Dion Timer" won't have the same MSID as "Panic by Dion Timmer", even if they are the same recording. **Usage:** `listenbrainz-cli-tools mapping list-unmapped [OPTIONS] ` ###### **Arguments:** * `` — Name of the user to fetch unlinked listen from ###### **Options:** * `-s`, `--sort ` — Sort the listens by type Possible values: - `count`: The count of listens for this element. This is descending by default - `name`: The name of the associated element - `oldest`: The oldest element ## `listenbrainz-cli-tools mapping mapper` Easy and faster mapping of recordings. It goes through each unmapped recordings, and give a few suggested recordings for the mapping. This is the exact same as mapping recording in the web UI. **Usage:** `listenbrainz-cli-tools mapping mapper [OPTIONS] ` ###### **Arguments:** * `` — Name of the user to fetch listens from ###### **Options:** * `-t`, `--token ` — Your user token. You can find it at . If it's set in the config file, you can ignore this argument * `-s`, `--sort ` — Sort the listens by type Possible values: `none`, `name`, `oldest-listen` ## `listenbrainz-cli-tools radio` Generate radio playlists for you **Usage:** `listenbrainz-cli-tools radio [OPTIONS] ` ###### **Subcommands:** * `circles` — Randomly adds recordings from artists you already listened to * `underrated` — Generate a playlist containing your underrated listens * `rate` — Generate playlists depending on the listen rate of recordings * `overdue` — Generate playlists based on recording that the user should have listened to by now ###### **Options:** * `--min-count ` — The minimum count of tracks the radio should add to the playlist. (Default: 50, gets overidden by `--min-duration`) * `--min-duration ` — The minimum duration the playlist should last for. This accept natural language (Ex: "1 hour 36 mins") ## `listenbrainz-cli-tools radio circles` Randomly adds recordings from artists you already listened to **Usage:** `listenbrainz-cli-tools radio circles [OPTIONS] [TOKEN]` ###### **Arguments:** * `` — Name of the user to fetch listens from * `` — Your user token. You can find it at . If it's set in the config file, you can ignore this argument ###### **Options:** * `--unlistened` — Use this flag to only get unlistened recordings. This is great for exploration playlists ## `listenbrainz-cli-tools radio underrated` Generate a playlist containing your underrated listens This radio will create a playlist containing all the tracks that you listen to, but seemingly no one else does. > The mix is made by calculating a score for each listen. This score is composed of two values: > - The rank in the user's top 1000 recording of all time (First place get 100 points, second get 999.9, etc...) > - The percentage of the recording's listens being from the user (Made with this formula: (user listens / worldwide listens) *100) **Usage:** `listenbrainz-cli-tools radio underrated [OPTIONS] ` ###### **Arguments:** * `` — Name of the user to fetch listens from ###### **Options:** * `-t`, `--token ` — Your user token. You can find it at . If it's set in the config file, you can ignore this argument ## `listenbrainz-cli-tools radio rate` Generate playlists depending on the listen rate of recordings This algorythm bases itself on your listen rate of recording to get more forgotten tracks. It takes the recordings with the lowest listen rates, and put them into a playlist **Usage:** `listenbrainz-cli-tools radio rate [OPTIONS] ` ###### **Arguments:** * `` — Name of the user to fetch listens from ###### **Options:** * `-t`, `--token ` — Your user token. You can find it at . If it's set in the config file, you can ignore this argument * `--min-rate ` — Minimum listen rate * `--min-per ` — Minimum listen rate time range Possible values: `year`, `month` * `--min ` — Minimum listen count * `-c`, `--cooldown ` — The amount of hours needed to wait after a recording have been given before it is re-suggested Default value: `0` ## `listenbrainz-cli-tools radio overdue` Generate playlists based on recording that the user should have listened to by now Similar to listen rates, this algorithm calculate the average time between listens, and estimate when the next listen will happen. It then put together a playlist made out of recordings you should have listened by now. **Usage:** `listenbrainz-cli-tools radio overdue [OPTIONS] ` ###### **Arguments:** * `` — Name of the user to fetch listens from ###### **Options:** * `-t`, `--token ` — Your user token. You can find it at . If it's set in the config file, you can ignore this argument * `--min ` — Minimum listen count * `-c`, `--cooldown ` — The amount of hours needed to wait after a recording have been given before it is re-suggested Default value: `0` * `-o`, `--overdue-factor` — Sort the recordings by the time overdue / the average time between listens Instead of sorting by date, the listens are sorted by how many estimated listens should have happened by now (Time elapsed since last listen / Average time per listens) Default value: `false` ## `listenbrainz-cli-tools stats` Shows top statistics for a specific target Target is the entity type to group the stats by. Currently, those entities stats are implemented: - Recordings (`recording`) - Artists (`artist`) - Releases (`release`) - Release Groups (`release_group`) - Works (`work`) **Usage:** `listenbrainz-cli-tools stats [OPTIONS] --target ` ###### **Arguments:** * `` — Name of the user to fetch stats listen from ###### **Options:** * `-t`, `--target ` — The type of entity to sort by Possible values: `recording`, `artist`, `release`, `release-group`, `work` * `-s`, `--sort ` — Sort by: Default value: `count` Possible values: - `count`: The count of listens for this element. This is descending by default - `name`: The name of the associated element - `oldest`: The oldest element
This document was generated automatically by clap-markdown.