ytdl-sub/docs/source/guides/getting_started/first_download.rst
2024-11-30 07:41:54 -08:00

39 lines
No EOL
1.1 KiB
ReStructuredText

Initial Download
================
Once you have a ``subscriptions.yaml`` file created, you can perform your first
download. Access ``ytdl-sub``, navigate to the directory containing your ``subscriptions.yaml``
file.
Dry Run
-------
Performing a dry run is important when applying any change to your subscriptions to
ensure output looks as expected. Dry runs will pull metadata to *simulate* a download
without actually downloading the media file.
.. code-block:: shell
ytdl-sub --dry-run sub subscriptions.yaml
Faster Iteration Cycle
----------------------
Testing subscriptions can take quite some time to perform a full download.
This can be speed up by applying an override via command-line to set max number
of downloads.
.. code-block:: shell
ytdl-sub --dry-run sub subscriptions.yaml -o '--ytdl_options.max_downloads 3'
Having many subscriptions could still make this dry run take a while. A subset of
subscriptions can be dry ran using a match.
.. code-block:: shell
:caption: Only run subscriptions that have PBS in their names
ytdl-sub --dry-run sub subscriptions.yaml -o '--ytdl_options.max_downloads 3' --match PBS
Downloading
-----------
WIP