Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turbot/steampipe-mod-github-sherlock
Interrogate your GitHub resources with the help of the world's greatest detectives: Powerpipe + Steampipe + Sherlock.
https://github.com/turbot/steampipe-mod-github-sherlock
github hacktoberfest powerpipe powerpipe-mod sql steampipe steampipe-mod steampipe-sherlock
Last synced: 6 days ago
JSON representation
Interrogate your GitHub resources with the help of the world's greatest detectives: Powerpipe + Steampipe + Sherlock.
- Host: GitHub
- URL: https://github.com/turbot/steampipe-mod-github-sherlock
- Owner: turbot
- License: apache-2.0
- Created: 2021-05-28T01:52:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T08:15:51.000Z (23 days ago)
- Last Synced: 2024-10-23T12:57:08.440Z (22 days ago)
- Topics: github, hacktoberfest, powerpipe, powerpipe-mod, sql, steampipe, steampipe-mod, steampipe-sherlock
- Language: Pascal
- Homepage: https://hub.powerpipe.io/mods/turbot/github_sherlock
- Size: 2.01 MB
- Stars: 39
- Watchers: 16
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Sherlock Mod for Powerpipe
Interrogate your GitHub resources with the help of the World's greatest
detectives: Powerpipe + Sherlock. GitHub Sherlock allows you to perform
deep analysis of your GitHub organization and repo configuration and test
them against operations & security best practices.
Run checks in a dashboard:
Or in a terminal:
## Documentation
- **[Benchmarks and controls →](https://hub.powerpipe.io/mods/turbot/github_sherlock/controls)**
- **[Named queries →](https://hub.powerpipe.io/mods/turbot/github_sherlock/queries)**
## Getting Started
### Installation
Install Powerpipe (https://powerpipe.io/downloads), or use Brew:
```sh
brew install turbot/tap/powerpipe
```
This mod also requires [Steampipe](https://steampipe.io) with the [Github plugin](https://hub.steampipe.io/plugins/turbot/github) as the data source. Install Steampipe (https://steampipe.io/downloads), or use Brew:
```sh
brew install turbot/tap/steampipe
steampipe plugin install github
```
Finally, install the mod:
```sh
mkdir dashboards
cd dashboards
powerpipe mod init
powerpipe mod install github.com/turbot/steampipe-mod-github-sherlock
```
### Browsing Dashboards
Start Steampipe as the data source:
```sh
steampipe service start
```
Start the dashboard server:
```sh
powerpipe server
```
Browse and view your dashboards at **http://localhost:9033**.
### Running Checks in Your Terminal
Instead of running benchmarks in a dashboard, you can also run them within your
terminal with the `powerpipe benchmark` command:
List available benchmarks:
```sh
powerpipe benchmark list
```
Run a benchmark:
```sh
powerpipe benchmark run github_sherlock.benchmark.org_best_practices
```
Different output formats are also available, for more information please see
[Output Formats](https://powerpipe.io/docs/reference/cli/benchmark#output-formats).
## Open Source & Contributing
This repository is published under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!
[Steampipe](https://steampipe.io) and [Powerpipe](https://powerpipe.io) are products produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). They are distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).
## Get Involved
**[Join #powerpipe on Slack →](https://turbot.com/community/join)**
Want to help but don't know where to start? Pick up one of the `help wanted` issues:
- [Powerpipe](https://github.com/turbot/powerpipe/labels/help%20wanted)
- [GitHub Sherlock Mod](https://github.com/turbot/steampipe-mod-github-sherlock/labels/help%20wanted)