Repository files navigation

A humble CLI for downloading and archiving podcasts.

Node Required

npx podcast-dl --url <PODCAST_RSS_URL>

Visit the releases page and download the latest binary for your system.

podcast-dl --url <PODCAST_RSS_URL>

Either--url or--file must be provided.

Type values surrounded in square brackets ([]) can be used as used as boolean options (no argument required).

• If passed the--archive [path] option,podcast-dl will generate/use a JSON archive at the provided path.
• Before downloading an episode or writing out metadata, it'll check if the item was saved previously and abort the save if found.

Options that support templates allow users to specify a template for the generated filename(s) or option. The provided template will replace all matched keywords with the related data described below. Each keyword must be wrapped in two braces like so:

--out-dir "./{{podcast_title}}"

--episode-template "{{release_date}}-{{title}}"

• podcast_title: Title of the podcast feed.
• podcast_link:link value provided for the podcast feed. Typically the homepage URL.

• title: The title of the episode.
• release_date: The release date of the episode inYYYYMMDD format.
• release_year: The release year (YYYY) of the episode.
• release_month: The release month (MM) of the episode.
• release_day: The release day (DD) of the episode.
• episode_num: The location number of where the episodes appears in the feed.
• url: URL of episode audio file.
• duration: Providedmm:ss duration (if found).
• podcast_title: Title of the podcast feed.
• podcast_link:link value provided for the podcast feed. Typically the homepage URL.
• guid: The GUID of the episode.

Each matcher provided will be used to extract a value from the episodetitle. Access these values in the template using thecustom_<n> keyword where<n> is the index of the matcher provided (starting from0).

If no match is found, thecustom_<n> keyword will be replaced with an empty string.

• episode_path: The path to the downloaded episode.
• episode_path_base: The path to the folder of the downloaded episode.
• episode_filename: The filename of the episode.
• episode_filename_base: The filename of the episode without its extension.
• url: URL of episode audio file.

By default, all logs and errors are outputted to the console. The amount of logs can be controlled using the environment variableLOG_LEVEL with the following options:

• static: All logs and errors are outputted to the console, but disables any animations.
• quiet: Only important info and non-critical errors will be logged (e.g. episode download started).
• silent: Only critical error messages will be be logged.

By default, the max length of a generated filename is255. If your OS has different limitations, or if you're running into issues with non-standard feeds, you can adjust the limit via the environment variableMAX_LENGTH_FILENAME.