Skip to main content

Quick Start

Scan a local directory​

monphare scan ./terraform

Example output:

MonPhare v0.3.0  [FAILED]  3 errors, 3 warnings
Scanned: 1 files, 4 modules, 3 providers

| Sev  | Resource              | Issue          | Current  | File      |
|------|-----------------------|----------------|----------|-----------|
| ERR  | module.vpc_no_version | No version     | -        | main.tf:0 |
| ERR  | module.git_module     | No version     | -        | main.tf:0 |
| ERR  | provider.aws          | No version     | -        | main.tf:0 |
| WARN | resource.google       | No upper bound | -        | main.tf:0 |
| WARN | resource.azurerm      | No upper bound | -        | main.tf:0 |
| WARN | provider.google       | Too broad      | >= 0.0.0 | main.tf:0 |
| INFO | resource.eks_exact    | Exact version  | -        | main.tf:0 |

Scan remote repositories​

Public repositories work without any token:

monphare scan https://github.com/terraform-aws-modules/terraform-aws-vpc

Scan multiple repos at once:

monphare scan \
  https://github.com/org/repo1 \
  https://github.com/org/repo2

Mix local and remote:

monphare scan ./local-repo https://github.com/org/remote-repo

Scan an entire GitHub org​

Public orgs work without a token:

monphare scan --github terraform-aws-modules

For private orgs, set a token:

export MONPHARE_GIT_TOKEN=ghp_xxxx
monphare scan --github my-private-org

Generate reports​

JSON report:

monphare scan ./terraform --format json --output report.json

HTML report:

monphare scan ./terraform --format html --output report.html

Create a configuration file​

monphare init

This generates a monphare.yaml with default settings you can customize.

See the Scanning section for more advanced use cases.