3c6fd0b4e8
* [BACKEND] Error if arg after positional arg * working * dry-run default * remove unused code
80 lines
2.2 KiB
ReStructuredText
80 lines
2.2 KiB
ReStructuredText
Usage
|
|
=======
|
|
|
|
.. code-block::
|
|
|
|
ytdl-sub [GENERAL OPTIONS] {sub,dl,view} [COMMAND OPTIONS]
|
|
|
|
For Windows users, it would be ``ytdl-sub.exe``
|
|
|
|
General Options
|
|
---------------
|
|
|
|
General options must be specified before the command (i.e. ``sub``).
|
|
|
|
.. code-block:: text
|
|
|
|
-h, --help show this help message and exit
|
|
-c CONFIGPATH, --config CONFIGPATH
|
|
path to the config yaml, uses config.yaml if not provided
|
|
--dry-run preview what a download would output, does not perform any
|
|
video downloads or writes to output directories
|
|
--log-level quiet|info|verbose|debug
|
|
level of logs to print to console, defaults to info
|
|
|
|
Sub Options
|
|
-----------
|
|
Download all subscriptions specified in each ``SUBPATH``.
|
|
|
|
.. code-block::
|
|
|
|
ytdl-sub [GENERAL OPTIONS] sub [SUBPATH ...]
|
|
|
|
``SUBPATH`` is one or more paths to subscription files, uses ``subscriptions.yaml`` if not provided.
|
|
It will use the config specified by ``--config``, or ``config.yaml`` if not provided.
|
|
|
|
Download Options
|
|
-----------------
|
|
Download a single subscription in the form of CLI arguments.
|
|
|
|
.. code-block::
|
|
|
|
ytdl-sub [GENERAL OPTIONS] dl [SUBSCRIPTION ARGUMENTS]
|
|
|
|
``SUBSCRIPTION ARGUMENTS`` are exactly the same as YAML arguments, but use periods (``.``) instead
|
|
of indents for specifying YAML from the CLI. For example, you can represent this subscription:
|
|
|
|
.. code-block:: yaml
|
|
|
|
rick_a:
|
|
preset:
|
|
- "tv_show"
|
|
overrides:
|
|
tv_show_name: "Rick A"
|
|
url: "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw"
|
|
|
|
Using the command:
|
|
|
|
.. code-block:: bash
|
|
|
|
ytdl-sub dl \
|
|
--preset "tv_show" \
|
|
--overrides.tv_show_name "Rick A" \
|
|
--overrides.url: "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw"
|
|
|
|
See how to shorten commands using
|
|
`download aliases <https://ytdl-sub.readthedocs.io/en/latest/config.html#ytdl_sub.config.config_validator.ConfigOptions.dl_aliases>`_.
|
|
|
|
View Options
|
|
-----------------
|
|
.. code-block::
|
|
|
|
ytdl-sub view [-sc] [URL]
|
|
|
|
.. code-block:: text
|
|
|
|
-sc, --split-chapters
|
|
View source variables after splitting by chapters
|
|
|
|
|
|
Preview the source variables for a given URL. Helps when creating new configs.
|