theapsgroup / steampipe-plugin-gitlab

Use SQL to instantly query GitLab projects, groups and more. Open source CLI. No DB required.

GitLab 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 theapsgroup/gitlab

Configure the plugin using the configuration file:

vi ~/.steampipe/gitlab.spc

Or environment variables:

export GITLAB_TOKEN=f7Ea3C3ojOY0GLzmhS5kE

Start Steampipe:

steampipe query

Run a query:

select
  full_path,
  visibility,
  forks_count,
  star_count
from
  gitlab_my_project;

Developing

Prerequisites:

• Steampipe
• Golang
• GitLab (either hosted or self-hosted)
• GitLab Token (either private or personal access token)

Clone:

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

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

make

Configure the plugin:

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

Try it!

steampipe query
> .inspect gitlab

Further reading:

• Writing plugins
• Writing your first table

Contributing

All contributions are subject to the Apache 2.0 open source license.

help wanted issues:

• Steampipe
• GitLab Plugin

Credits

GitLab API Wrapper xanzy/go-gitlab (licensed separately using this Apache License)