Commands reference

Global

Since the 0.4.0 version, OCT only provide one entry points for all commands. To see all avaibles sub-commands type:

oct -h

You should see :

usage: oct [-h]

       {to-csv,rebuild,pack,rebuild-results,new,results-to-csv,run,new-project,pack-turrets}
       ...

positional arguments:
  {to-csv,rebuild,pack,rebuild-results,new,results-to-csv,run,new-project,pack-turrets}
                        sub commands avaibles
    new-project (new)   create a new oct project
    pack-turrets (pack)
                        create turrets packages from a given oct project
    run                 run an oct project
    rebuild-results (rebuild)
                        Rebuild the html report from result dir
    results-to-csv (to-csv)
                        Create a csv file from a sqlite results file

optional arguments:
  -h, --help            show this help message and exit

Each sub command has its own help

New project

Create a new OCT project

aliases :

  • new-project
  • new

usage :

oct new-project <path-to-project>

Arguments :

name type mandatory description
project str yes path of the new project

Pack turrets

Create all turrets package from config file

aliases :

  • pack-turrets
  • pack

usage :

oct pack-turrets <path-to-project>

Arguments :

name type mandatory description
path str yes path of the project

Run

Run an OCT project

aliases :

  • run

usage :

oct run <path-to-project>

Arguments :

name type mandatory description
project str yes path of the project
-r, –results str no specifiy a custom directory for the results
-d, –directyory str no specify the project directory if not current

Rebuild results

Rebuild html results and graph from existing sqlite result file

aliases :

  • rebuild-results
  • rebuild

usage :

oct rebuild-results <path-to-results> <path-to-sqlite> <path-to-config>

Arguments :

name type mandatory description
results_dir str yes results directory to rebuild
results_file str yes sqlite result file to use
config_file str yes json config file of the project

Results to csv

Convert sqlite results to csv

aliases :

  • results-to-csv
  • to-csv

usage :

oct results-to-csv [-h] [-d DELIMITER] <result_file> <output_file>

Arguments :

name type mandatory description
results_file str yes sqlite result file to use
output_file str yes csv output file
-d, –delimiter str no specify custom delimiter for csv file