Python command-line interface for Scanner API
Project description
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 codevalidate
- 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for scanner_cli-0.1.0rc3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5091369504bf767599b0b2ff8e719cb43b6252c3655035fb7db9de1868325e2 |
|
MD5 | cf897f35df660c5af444ae512a102cc4 |
|
BLAKE2b-256 | 7fd3385db73691d1623a30634451eb328a06ae074206e3e17b7c20b1e8a4184f |