<commit_before>shone-phar
=======

A command-line tool for interacting with the Shone Web Scanner API.

You will need to create a free account on https://www.shone.co.za/


Compiling the phar
-----
You'll need to compiler the phar by calling:

    bin/compiler && chmod +x shone.phar

You can then copy the phar to any server or directory you wish and use it as a stand-alone executable.


Using the phar
-----

You can scan a web directory like this:

    ./shone.phar scan --key "[API KEY]" --label "Website Label" /path/to/web/folder

or if you prefer to use the code directly

    ./bin/shone scan --key "[API KEY]" --label "Website Label" /path/to/web/folder

If everything went ok you should be provided with a URL to find the result of your scan


More information
-----

For more information run:

    ./shone.phar<commit_msg>Updated readme with new instuctions<commit_after>shone-phar
=======

A command-line tool for interacting with the Shone Web Scanner API.

To perform scans you will need to create a free account on https://www.shone.co.za/

Getting started
-----

The easiest way is to just download the phar file and get started

    wget raw.github.com/xsist10/shone-phar/master/shone.phar && chmod +x shone.phar


Using the scanner
-----

You can scan a web directory like this

    ./shone.phar scan --key "[API KEY]" --label "Website Label" /path/to/web/folder

or if you prefer to use the code directly (remember to run composer update first)

    ./bin/shone scan --key "[API KEY]" --label "Website Label" /path/to/web/folder

If everything went ok you should be provided with a URL to find the result of your scan


Compiling the phar
-----
You'll can recompile the phar by calling:

    bin/compiler && chmod +x shone.phar

You can then copy the phar to any server or directory you wish and use it as a stand-alone executable.


More information
-----

For more information run:

    ./shone.phar
{'fraction_non_alphanumeric': 0.09578344612181156, 'fraction_numerical': 0.001041124414367517, 'mean_word_length': 3.03781512605042, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3152838', 'n_tokens_mistral': 602, 'n_tokens_neox': 562, 'n_words': 271}