scanner-cli 0.1.0rc4

Python command-line interface for Scanner API

scanner-cli

This is a Python CLI for the Scanner API.

Usage

To install the CLI, run

pip install scanner-cli

You will need to provide the API URL of your Scanner instance and an API key. Go to Settings > API Keys to find your API URL and API key.

You can either set these values as environment variables:

export SCANNER_API_URL=<your API URL>
export SCANNER_API_KEY=<your API key>

or provide them as arguments to the CLI:

scanner-cli <command> --api-url=<your API url> --api-key=<your API key>

Commands

Available commands are

• run-tests - run tests on detection rules as code
• validate - validate detection rules as code

To validate or run tests on files

scanner-cli <command> -f detections/src/errors.yaml -f detections/src/unauthorized_logins.yaml

To validate or run tests on directories

scanner-cli <command> -d detections/src

This will validate or run tests on all YAML files in the directory that have the correct schema header.

A file or directory must be provided. Multiple files and/or directories can be provided.