diff --git a/arachni/README.md b/arachni/README.md index 77432dc..d766469 100644 --- a/arachni/README.md +++ b/arachni/README.md @@ -1,16 +1,18 @@ +This script is a command line tool for easily converting arachni json output into a Nucleus format for easy upload into Nucleus. + + Install: Need to install python3 and the requests library -Usage: -CLI tool +Usage: -python arachni_json_parse.py -i -o +python arachni_json_parse.py -i {arachni json input file} -o {nucleus json outputfile} -Optional: -# +Optional: -# {Project ID of the Nucleus project to which you want to upload the outputfile} If a project ID is not specified, the script will just create a json file in the local directory. If a project ID is specified, then will post the Nucleus outputfile to that Nucleus project. -Note: If you want to post the file to Nucleus you will need to get an API key from the Nucleus console and update the NUCLEUS_ROOT_URL in the python script. \ No newline at end of file +Note: If you want to post the file to Nucleus you will need to get an API key from the Nucleus console and update the NUCLEUS_ROOT_URL in the python script.