Repo Usage Cheatsheet

While we work on formal documentation here is a cheetsheet of common repo usage:

  • note: currently works with public repos. We are working on git auth.

Repo Scanning#

ghost repo https://github.com/facebook/react.git

Custom Policy#

Ghost supports custom policy driven by OPA. You can specify a local rego file or OPA endpoint. Scanner binary will issue exit code 2 for failed policies.

ghost repo --rego-file ghost.rego https://github.com/facebook/react.git

Custom templating and Reporting#

ghost repo --format template --template @ghost.tpl -o report.html https://github.com/facebook/react.git
Edit this page