turbot/github_sherlock
GitHub

GitHub Sherlock Mod

Interrogate your GitHub resources with the help of the world's greatest detectives: Steampipe + Sherlock.

References

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.

Documentation

Getting started

Installation

Download and install Steampipe (https://steampipe.io/downloads). Or use Brew:

brew tap turbot/tap
brew install steampipe

Install the GitHub plugin with Steampipe:

steampipe plugin install github

Clone:

git clone https://github.com/turbot/steampipe-mod-github-sherlock.git
cd steampipe-mod-github-sherlock

Usage

Start your dashboard server to get started:

steampipe dashboard

By default, the dashboard interface will then be launched in a new browser window at http://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.

Credentials

This mod uses the credentials configured in the Steampipe GitHub plugin.

Configuration

No extra configuration is required.

Contributing

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.

Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.

Want to help but not sure where to start? Pick up one of the help wanted issues: