pldl (YouTube Playlist Downloader)

pldl is a command-line interface (CLI) tool that allows you to easily download YouTube playlists. With pldl, you can specify the playlist ID and download all the videos within the playlist for offline viewing.

Installation

To install pldl, run the following command:

npm install -g pldl

Usage

To download a YouTube playlist using pldl, use the following command:

pldl {playlistID}

Replace {playlistID} with the ID of the YouTube playlist you want to download.

Configuration

Before using pldl, you can configure the following settings:

API Key

To set up your YouTube API key, follow these steps:

1. Obtain a YouTube Data API key from the Google Developers Console.
2. Run the following command to configure pldl with your API key:

pldl setting.key='{api_key}'

Replace {api_key} with your YouTube Data API key.

Playlist Folder

You can customize the folder behavior for playlist downloads using the following setting:

• playlistFolder: Specifies the folder behavior for playlists. Available values are:
  • true: Create a folder named after the playlist for each download.
  • false: Download files directly into the current directory without creating a dedicated folder.

Example:

• Set the YouTube API key:

pldl setting.key='YOUR_API_KEY'

• Configure the folder creation option:

pldl setting.plFolder=true

When you set plFolder to true, pldl will create a folder with the same name as the playlist for each download. For example, if the playlist is named "My Playlist", pldl will create a folder named "My Playlist" and download all the videos inside it.

On the other hand, if you set plFolder to false, pldl will download the files directly into the current directory without creating a dedicated folder.

Choose the option that suits your preference and organization needs.

Progress Bar Style

You can configure the progress bar style using the progStyle setting. This setting determines the appearance of the progress bar during the download process.

Allowed Values:

• 1: Display a progress bar using the characters "━" for completed and "╺" for remaining.
• 2: Display a progress bar using the characters "▓" for completed and "░" for remaining.
• 3: Display a progress bar using the characters "■" for completed and "░" for remaining.
• 4: Display a progress bar using the characters "=" for completed and "." for remaining.
• 5: Display a progress bar using the characters "█" for completed and "░" for remaining.
• 6: Display a progress bar using the characters "▒" for completed and "░" for remaining.
• 7: Display a progress bar using the characters "⬛" for completed and "⬜" for remaining.
• 8: Display a progress bar using the characters "◼" for completed and "◻" for remaining.

Default Value:

The default value for progStyle is 1, which displays a progress bar using the characters "━" and "╺".

Usage:

To configure the progress bar style, use the following command:

pldl setting.progStyle=<value>

Replace <value> with one of the allowed values listed above. Example:

Set the progress bar style to 5:

pldl setting.progStyle=5

This setting allows you to customize the appearance of the progress bar during the download process. Choose the style that suits your preference.

Examples

Here are a few examples to illustrate the usage of pldl:

• Download a playlist with ID PLnKtcw5mIGUR-aMBz9AphxHzEH7Kt-azY:

pldl PLnKtcw5mIGUR-aMBz9AphxHzEH7Kt-azY

• Set the YouTube API key:

pldl setting.key='YOUR_API_KEY'

• Set the folder creation option to create a dedicated folder for each playlist:

pldl setting.plFolder=true

• Set the maximum number of results to 100:

pldl setting.maxResults=100

Important Note

Please note that downloading YouTube videos without proper authorization may violate YouTube's terms of service or copyright laws. Ensure that you have the necessary rights or permissions to download and use the videos from YouTube.

License

pldl is released under the MIT License.

Feedback and Contributions

Your feedback and contributions are welcome! If you encounter any issues or have suggestions for improvements, please submit them on the GitHub repository.