GitHub Sherlock Mod
Interrogate your GitHub resources with the help of the world's greatest detectives: Steampipe + Sherlock.
GitHub is a provider of Internet hosting for software development and version control using Git.
Steampipe is an open source CLI to instantly query cloud APIs using SQL.
Steampipe Mods are collections of
named queries, and codified
controls that can be used to test current configuration of your cloud resources against a desired configuration.
Download and install Steampipe (https://steampipe.io/downloads). Or use Brew:
brew tap turbot/tapbrew install steampipe
Install the GitHub plugin with Steampipe:
steampipe plugin install github
git clone https://github.com/turbot/steampipe-mod-github-sherlock.gitcd steampipe-mod-github-sherlock
Start your dashboard server to get started:
By default, the dashboard interface will then be launched in a new browser window at https://localhost:9194. From here, you can run benchmarks by selecting one or searching for a specific one.
Instead of running benchmarks in a dashboard, you can also run them within your
terminal with the
steampipe check command:
Run all benchmarks:
steampipe check all
Run a single benchmark:
steampipe check benchmark.org_best_practices
Run a specific control:
steampipe check control.org_two_factor_required
Different output formats are also available, for more information please see Output Formats.
This mod uses the credentials configured in the Steampipe GitHub plugin.
No extra configuration is required.
If you have an idea for additional controls or just want to help maintain and extend this mod (or others) we would love you to join the community and start contributing.
- Join our Slack community → and hang out with other Mod developers.
Want to help but not sure where to start? Pick up one of the
help wanted issues: