<commit_before>.. _usage_cli:

StackHut Toolkit
================


.. Introduction
.. ------------

The Toolkit is used to create, test, deploy, and maintain your services hosted on StackHut.
It provides a range of commands used to interact with your code and the StackHut servers.

Getting Started
^^^^^^^^^^^^^^^

First off, install the Toolkit and requirements following the instructions in :ref:`installation`. 

Quick Install - ``sudo pip3 install stackhut`` (to upgrade - ``sudo pip3 install --upgrade stackhut``)

.. note:: Things move pretty quickly on the Toolkit so if you find an error try upgrading first to see if it's been fixed. Thanks!

Usage
-----

Having installed the Toolkit just make sure it's accessible from your path<commit_msg>add ToolKit info<commit_after>.. _usage_cli:

StackHut Toolkit
================


.. Introduction
.. ------------

The Toolkit is used to create, test, deploy, and maintain your services hosted on StackHut.
It provides a range of commands used to interact with your code and the StackHut servers.

Getting Started
^^^^^^^^^^^^^^^

First off, install the Toolkit and requirements by following the instructions in :ref:`installation`. 

**Quick Install**

.. code:: bash

    sudo pip3 install stackhut
    
**Upgrade**

.. code:: bash

    sudo pip3 install --upgrade stackhut

.. note:: Things move pretty quickly on the Toolkit so if you find an error try upgrading first to see if it's been fixed. Thanks!

Usage
-----

Having installed the Toolkit just make sure it's accessible from your path
{'fraction_non_alphanumeric': 0.12015503875968993, 'fraction_numerical': 0.002583979328165375, 'mean_word_length': 3.693939393939394, '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': '6240147', 'n_tokens_mistral': 424, 'n_tokens_neox': 397, 'n_words': 205}