Command Line Interface

middguard init

Scaffold the files to begin a MiddGuard investigation.

  Usage: middguard-init [options]

  Options:

    -h, --help               output usage information
    -V, --version            output the version number
    --middguard-path [path]  Path to MiddGuard installation
    --secret-key [key]       Secret key for development

middguard migrate

Run the MiddGuard migrations. This creates and updates tables for MiddGuard's internal components. It only needs to be run at the start of a project or when MiddGuard is updated.

  Usage: middguard-migrate [options]

  Options:

    -h, --help         output usage information
    -V, --version      output the version number
    --debug            Run with debugging.
    --knexfile [path]  Specify the knexfile path.
    --env [name]       environment, default: process.env.NODE_ENV || development

middguard module analytics

Scaffold the directories and files for a new analytics module.

  Usage: middguard-module-analytics [options]

  Options:

    -h, --help         output usage information
    -V, --version      output the version number
    -n, --name [name]  The name for the module

middguard module vis

Scaffold the directories and files for a new visualization module.

  Usage: middguard-module-vis [options]

  Options:

    -h, --help         output usage information
    -V, --version      output the version number
    -n, --name [name]  The name for the module