NAME
ruby-gitlab - command line interface to gitlab
SYNOPSIS
ruby-gitlab command
DESCRIPTION
ruby-gitlab is a command line interface to gitlab based on the gitlab gem. It requires to set a few environment variables (see configuration).
For a complete list of supported CLI commands, see:
<http://www.rubydoc.info/gems/gitlab/Gitlab/Client>
Any of those methods can be called as a command by passing the parameters of the commands as parameters of ruby-gitlab.
CONFIGURATION
- A few environment variables needs to be set:
-
export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v4
export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
- 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}"
EXAMPLES
- To list users:
-
ruby-gitlab users
- To get current user:
-
ruby-gitlab user
- The result can be filtered:
-
ruby-gitlab user --only=id,username
ruby-gitlab user --except=email,bio
SEE ALSO
- •
-
gem documentation <http://www.rubydoc.info/gems/gitlab/Gitlab/Client>
- •
-
/usr/share/doc/ruby-gitlab/README.md.gz
AUTHOR
Sophie Brun <[email protected]>