precli 0.3.13

Static analysis security tool command line

Precli is the core of the GitHub App Precaution and also a command line interface to demonstate its functionality.

Quick Start

To install precli:

pip install precli

Run precli on a single test example:

precli tests/unit/rules/python/stdlib/examples/hmac_timing_attack.py

Run precli on a single test example, showing results in SARIF format:

precli tests/unit/rules/python/stdlib/examples/hmac_timing_attack.py --json

Run precli on a single test example, showing results in plain format:

precli tests/unit/rules/python/stdlib/examples/hmac_timing_attack.py --plain

Run precli on a single test example, showing results in markdown format:

precli tests/unit/rules/python/stdlib/examples/hmac_timing_attack.py --markdown

Run precli against all the python test examples:

precli -r tests/unit/rules/python/stdlib/examples/

Run precli against an entire GitHub repository:

precli -r https://github.com/securesauce/precli

Run precli against an entire GitHub repository and output the results in markdown format to Gist. Note: this requires a GITHUB_TOKEN environment variable set to a valid GitHub token value:

precli -r https://github.com/securesauce/precli --markdown --gist