Skip to content

usage.rst

Latest commit

 

History

History
70 lines (42 loc) · 1.71 KB

usage.rst

File metadata and controls

70 lines (42 loc) · 1.71 KB

Usage

To see the available options and arguments, run the following command:

$ instawebhooks --help

Examples

  • Send new posts:
$ instawebhooks <INSTAGRAM_USERNAME> <DISCORD_WEBHOOK_URL>
  • Send new posts with verbose logging:
$ instawebhooks -v <INSTAGRAM_USERNAME> <DISCORD_WEBHOOK_URL>
  • Send new posts every 30 minutes:
$ instawebhooks -i 1800 <INSTAGRAM_USERNAME> <DISCORD_WEBHOOK_URL>
  • Send new posts with a custom message:
$ instawebhooks -c "New post from {owner_name}: {post_url}" <INSTAGRAM_USERNAME> <DISCORD_WEBHOOK_URL>
  • Send new posts with no embed and a custom message:
$ instawebhooks -e -c "New post from {owner_name}: {post_url}" <INSTAGRAM_USERNAME> <DISCORD_WEBHOOK_URL>
  • Send new posts for multiple Instagram usernames and Discord webhook URLs:
$ instawebhooks <INSTAGRAM_USERNAME_1> <INSTAGRAM_USERNAME_2> ... <DISCORD_WEBHOOK_URL_1> <DISCORD_WEBHOOK_URL_2> ...

Reference

.. argparse::
   :module: src.instawebhooks.parser
   :func: parser
   :prog: instawebhooks
   :noepilog:

   instagram_username : @after
        Usernames must follow the Instagram username format:

        * Starts with a letter or underscore.
        * Does not contain consecutive periods.
        * Is between 2 and 30 characters long.
        * Ends with an alphanumeric character or underscore.

   discord_webhook_url : @after
        URLs must follow the Discord webhook URL format:

        * ``https://discord.com/api/webhooks/{webhook_id}/{webhook_token}``
        * ``https://discordapp.com/api/webhooks/{webhook_id}/{webhook_token}``