Skip to content

gitlabctl Documentation#

Hello and welcome to the gitlabctl documentation. While we always want to provide the most comprehensive documentation possible, we thought you may find the below sections a helpful place to get started.

  • The Getting Started section provides onboarding material
  • The Development header is the best place to get started on developing on top of and with gitlabctl
  • See the Docs section for a comprehensive rundown of gitlabctl capabilities

About gitlabctl#

gitlabctl offers security teams a way to tie Gitlab primitives into their security workflows, ensuring that they leverage those primitives within their security automation pipelines. Designed with data-modeling and data-integration needs in mind, gitlabctl can be used on its own as an interactive CLI, orchestrated as part of a broader data pipeline, or leveraged from within the Method Platform.

The types of scans that gitlabctl can conduct are constantly growing. For the most up to date listing, please see the documentation here

To learn more about gitlabctl, please see the Documentation site for the most detailed information.

Quick Start#

Get gitlabctl#

For the full list of available installation options, please see the Installation page. For convenience, here are some of the most commonly used options:

Authentication#

gitlabctl takes advantage of Gitlab's Personal Access Tokens to authenticate to the Gitlab instance. This token will need to be passed to the gitlabctl command you wish to call, and can be handled in one of two ways.

  1. Set a GITLAB_TOKEN environment variable with a value equal to the token's value
  2. Pass the token in as an argument via the --token flag.
  3. Note that this is not recommended in production scenarios as you should avoid having your token logged in your command line history.

General Usage#

gitlabctl portscan <target>

Examples#

gitlabctl projects --group-id <group> --mine false --base-url https://gitlab.com/api/v4

Contributing#

Interested in contributing to gitlabctl? Please see our organization wide Contribution page.

Want More?#

If you're looking for an easy way to tie gitlabctl into your broader cybersecurity workflows, or want to leverage some autonomy to improve your overall security posture, you'll love the broader Method Platform.

For more information, visit us here

Community#

gitlabctl is a Method Security open source project.

Learn more about Method's open source source work by checking out our other projects here or our organization wide documentation here.

Have an idea for a Tool to contribute? Open a Discussion here.