Skip to content

command-line-interface.rst

Latest commit

 

History

History
59 lines (39 loc) · 1.56 KB

command-line-interface.rst

File metadata and controls

59 lines (39 loc) · 1.56 KB

Command Line Interface

The main entry point is Django's :guilabel:`manage.py` management commands.

$ ./manage.py --help

Lists all sub-commands available, including Django built-in commands. VulnerableCode's own commands are listed under the [vulnerabilities] section:

$ ./mange.py --help
...
[vulnerabilities]
    create_cpe_to_purl_map
    importer
    improver

$ ./manage.py <subcommand> --help

Displays help for the provided sub-command.

For example:

$ ./manage.py import --help
usage: manage.py import [-h] [--list] [--all] [--version] [-v {0,1,2,3}]
                        [--settings SETTINGS] [--pythonpath PYTHONPATH]
                        [--traceback] [--no-color] [--force-color]
                        [--skip-checks]
                        [sources [sources ...]]

Import vulnerability data

positional arguments:
  sources               Fully qualified importer name to run

$ ./manage.py import <importer-name>

Import vulnerability data using the given importer name.

Other variations:

  • --list List all available importers
  • --all Run all available importers

$ ./manage.py improve <improver-name>

Improve the imported vulnerability data using the given improver name.

Other variations:

  • --list List all available improvers
  • --all Run all available improvers