RUBY-GITLAB(1)

πŸ’– RUBY-GITLAB β€” the ruby-gitlab manual page, bestie edition πŸ’–

okay so this is the man page for ruby-gitlab, from the User commands manual section. literally the whole thing is right here, let's go πŸ¦‹


✨ NAME ✨

ruby-gitlab β€” a command line interface to gitlab πŸ’…


✨ SYNOPSIS ✨

ruby-gitlab command

✨ DESCRIPTION ✨

so ruby-gitlab is a command line interface to gitlab, and it's built on top of the gitlab gem 🌸 it does require you to set a few environment variables first tho (scroll down to configuration, i got you) πŸ™ˆ

for the complete list of supported CLI commands, go look at:

<http://www.rubydoc.info/gems/gitlab/Gitlab/Client>

and here's the cute part β€” any of those methods can be called as a command, just by passing the parameters of the commands as parameters of ruby-gitlab. like, all of them. periodt πŸ’œ


✨ CONFIGURATION ✨

a few environment variables need to be set, no cap:

export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v4

export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
heads up bestie: that private token comes from /profile/account β€” go grab it there πŸ”‘

the variable GITLAB_API_HTTPARTY_OPTIONS is optional ✨ it can be used to set any HTTParty option you may need, using YAML hash syntax. for example, SSL verification can be disabled with:

export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
ngl turning off SSL verification is giving risky behavior, but that's what the man page says so there it is πŸ’€

✨ EXAMPLES ✨

to list users:

ruby-gitlab users

to get current user:

ruby-gitlab user

and the result can be filtered, which is genuinely so iconic:

ruby-gitlab user --only=id,username

ruby-gitlab user --except=email,bio

✨ SEE ALSO ✨


✨ AUTHOR ✨

Sophie Brun <sophie@freexian.com> πŸŽ€ (ty for your service, queen πŸ‘‘)


and that's the whole page fr fr 🫢 this was version 4.14.1, dated 2020-04-04, straight from the RUBY-GITLAB(1) manual β€” love that for us πŸ’–βœ¨