Skip to content

Rework the usage #35

@maaaaz

Description

@maaaaz

Hello,

It would be great to rework the current usage options:

$ certitude -h
usage: certitude [-h] [-c COMPONENT] [-b BATCH_NAME] command

CERTitude, the modular Python scanner, network mapper and IOC Seeker

positional arguments:
  command               command to run ('init', 'run')

optional arguments:
  -h, --help            show this help message and exit
  -c COMPONENT, --component COMPONENT
                        component to run ('interface', 'iocscan')
  -b BATCH_NAME, --batch-name BATCH_NAME
                        [iocscan] Specify batch name

With this current usage options, I naively understand that:

  • Without specific option I could type:

    • certitude init: which really exists, for the first launch
    • and certitude run: which does not exist
  • With specific options I could type:

    • certitude -c interface run: which exists
    • and certitude -c interface init: which does not exists
    • and certitude -c iocscan init: which does not exist
    • and certitude -c iocscan run: which exists
    • and certitude -b <batchname> init: which does not exist
    • and certitude -b <batchname> run: which does exist

So, the init command is really misleading so you should make it a specific option (better, mandatory for the first launch), not positional argument.
IHMO you should go
from

$ certitude -h
usage: certitude [-h] [-c COMPONENT] [-b BATCH_NAME] command

CERTitude, the modular Python scanner, network mapper and IOC Seeker

positional arguments:
  command               command to run ('init', 'run')

optional arguments:
  -h, --help            show this help message and exit
  -c COMPONENT, --component COMPONENT
                        component to run ('interface', 'iocscan')
  -b BATCH_NAME, --batch-name BATCH_NAME
                        [iocscan] Specify batch name

to

$ certitude -h
usage: certitude [-h] [-c COMPONENT] [-b BATCH_NAME] command

CERTitude, the modular Python scanner, network mapper and IOC Seeker

positional arguments:
  command               command to run ('run')

optional arguments:
  -h, --help            show this help message and exit
  -i, --init            init the database and create user accounts (for the first launch)
  -c COMPONENT, --component COMPONENT
                        component to run ('interface', 'iocscan')
  -b BATCH_NAME, --batch-name BATCH_NAME
                        [iocscan] Specify batch name

Cheers.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions