<commit_before>=====
Usage
=====

shpkpr is mostly self-documenting, and documentation for any command can be viewed by passing the ``--help`` parameter, e.g.::

    $ shpkpr --help
    Usage: shpkpr [OPTIONS] COMMAND [ARGS]...

      A tool to manage applications running on Marathon.

    Options:
      --marathon_url TEXT      URL of the Marathon API to use.
      --help                   Show this message and exit.

    Commands:
      deploy  Deploy application from template.
      list    Lists all deployed applications
      show    Show application details.

For more detailed usage instructions use the sections linked below:

.. toctree::
   :maxdepth: 1

   configuration

   cmd_list
   cmd_show
   cmd_deploy<commit_msg>Add cron docs link to usage index page<commit_after>=====
Usage
=====

shpkpr is mostly self-documenting, and documentation for any command can be viewed by passing the ``--help`` parameter, e.g.::

    $ shpkpr --help
    Usage: shpkpr [OPTIONS] COMMAND [ARGS]...

      A tool to manage applications running on Marathon.

    Options:
      --marathon_url TEXT      URL of the Marathon API to use.
      --help                   Show this message and exit.

    Commands:
      deploy  Deploy application from template.
      list    Lists all deployed applications
      show    Show application details.

For more detailed usage instructions use the sections linked below:

.. toctree::
   :maxdepth: 1

   configuration

   cmd_list
   cmd_show
   cmd_deploy
   cmd_cron
{'fraction_non_alphanumeric': 0.07270323859881031, 'fraction_numerical': 0.0013218770654329147, 'mean_word_length': 2.4724770642201834, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2183799', 'n_tokens_mistral': 430, 'n_tokens_neox': 393, 'n_words': 173}