Ctrl+K

Getting Started

Getting Started#

Now that you’ve completed your install of ytdl-sub, it’s time to get started. This is a 3-step process:

  • Create your configuration file (if the Prebuilt Presets don’t fit your needs)

  • Create your subscription file

  • Automate starting YTDL-Sub

Prerequisite Knowledge#

In order to use ytdl-sub in any of the forms listed in these docs, you will need some basic knowledge.

Be sure that you:

☑ Can navigate directories in a command line interface (or CLI)

☑ Have a basic understanding of YAML syntax

If you plan on using the headless image of ytdl-sub, you:

☑ Can use nano or vim to edit OR

☑ Can mount the config directory somewhere you can open it using gui text editors

Additional useful (but not required) knowledge:

☑ Understanding how yt-dlp works

Overview#

ytdl-sub uses two types of YAML files:

subscriptions.yaml#

Defines subscriptions, which specify the media we want to recurrently download, like YouTube channels and playlists, SoundCloud artists, or any yt-dlp supported site. subscriptions use presets to define how ytdl-sub should handle downloading, processing, and saving them.

ytdl-sub comes packaged with many prebuilt presets that will play nicely with well-known media players.

config.yaml#

To customize ytdl-sub to beyond the prebuilt presets, you will need a config.yaml file. This file is where custom presets can be defined to orchestrate ytdl-sub to your very specific needs.

Running ytdl-sub#

To invoke ytdl-sub to download subscriptions, use the following command:

ytdl-sub sub subscriptions.yaml

ytdl-sub.exe sub subscriptions.yaml

ytdl-sub initially downloads all files to a defined working_directory. This is a temporary storage spot for metadata and media files so that errors during processing- if they occur- don’t affect your existing media library. Once all file processing is complete, your media files are moved to the output_directory.

Ready to Start?#

Now that you have installed ytdl-sub, checked your skills, and gotten a bit of background on how ytdl-sub functions, read through the articles below to get started:

Step 1: Initial Subscriptions

Step 2: Your First Download

Step 3: Automating Downloads

Want to go a step further?

If you want to use atypical paths or specific configuration options, check out Basic Configuration

For tips on creating your own presets when the prebuilt presets aren’t cutting it, check out Advanced Configuration

Other docs that may be of use:

Prebuilt Presets

Using Example Configs

Contents