Command Line Interface (CLI) Usage
===================================

App names
----------

There is few app names in zippyshare-downloader:

- ``zippyshare-dl``
- ``zippyshare-downloader``

.. note::

    If none of above doesn't work use this

    .. code-block:: shell

        # For Windows
        py -3 -m zippyshare_downloader

        # For Linux
        python3 -m zippyshare_downloader


Options
-------

Global options
~~~~~~~~~~~~~~~

- ``ZIPPYSHARE_URL or FILE``     Zippyshare URL or file containing zippyshare urls
- ``--no-download``              No download file
- ``--verbose``, ``-v``          Enable verbose
- ``--replace``, ``-r``          Replace file if exist
- ``--silent``                   No output

File / Folder related
~~~~~~~~~~~~~~~~~~~~~~

- ``--folder FOLDER``            Store downloaded file in given folder
- ``--filename FILENAME``        Rewrite filename. Will be ignored if using multiple urls

Zip and unzip
~~~~~~~~~~~~~~

- ``--zip FILENAME``, ``-z FILENAME`` Zip all downloaded files
- ``--unzip``, ``-uz`` Unzip all downloaded files, one by one

.. warning:: 
    
    Option ``--zip`` or ``-z`` will only work if you are using multiple zippyshare urls

    For example:

    .. code-block:: shell

        # This will work
        $ zippyshare-dl "urls.txt" --zip

        # This will NOT work
        $ zippyshare-dl "https://www.zippyshare.com/v/..." --zip

Download related
~~~~~~~~~~~~~~~~~

- ``--async`` Run zippyshare-downloader in asynchronous mode
- ``--fast`` Enable fast download

.. note::

    When you using ``--async`` option, the download is faster than without using
    ``--async`` one.

.. warning::

    ``--fast`` option require ``--async``. It will throw error if you specified
    ``--fast`` without ``--async`` option.

    For example:

    .. code-block:: shell

        # This will work
        $ zippyshare-dl "https://www.zippyshare.com/v/..." --async --fast

        # This will NOT work
        $ zippyshare-dl "https://www.zippyshare.com/v/..." --fast

Pipe to media player (etc: vlc)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- ``-pipe`` Download to stdout, useful for piping media content to media player (like vlc)

Example Usage

.. code-block:: shell

    # Let's say you want watching videos with vlc from zippyshare
    # this can be done with piping the stdout from zippyshare-dl
    $ zippyshare-dl "insert zippyshare url here" -pipe | vlc -

    # or (for Linux / Mac OS)
    $ python3 -m zippyshare_downloader "insert zippyshare url here" -pipe | vlc -

    # or (for Windows)
    $ py -3 -m zippyshar_downloader "insert zippyshare url here" -pipe | vlc -

Proxy related
~~~~~~~~~~~~~~

- ``--proxy PROXY`` Set a http/socks proxy, all network in this app will be re-routed from this proxy.
- ``--proxy-trust-env`` Enable http/socks proxy from environments (``http_proxy``, ``https_proxy``).

.. Warning::

    If you specified ``--proxy`` and ``--proxy-trust-env``, option ``--proxy-trust-env`` will be ignored.