steampipe-plugin-github

GitHub Plugin for Steampipe

• Get started →
• Documentation: Table definitions & examples
• Community: Join #steampipe on Slack →
• Get involved: Issues

Quick start

Install the plugin with Steampipe:

steampipe plugin install github

Configure the plugin using the configuration file:

vi ~/.steampipe/github.spc

Or environment variables:

export GITHUB_TOKEN=ghp_YOURTOKENHERE

Start Steampipe:

steampipe query

Run a query:

select
  name,
  language,
  forks_count,
  stargazers_count
from
  github_my_repository;

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

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

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/github.spc

Try it!

steampipe query
> .inspect github

Further reading:

• Writing plugins
• Writing your first table

Contributing

Please see the contribution guidelines and our code of conduct. Contributions to the plugin are subject to the Apache 2.0 open source license. Contributions to the plugin documentation are subject to the CC BY-NC-ND license.

help wanted issues:

• Steampipe
• GitHub Plugin