CLI

IMPORTANT

You need to set environment variables before using the CLI.

Commands

Send gitlab methods as commands, and parameters as arguments to the gitlab command-line utility

gitlab users

gitlab user

gitlab user 2

Filter

You can filter output by supplying --only or --except flags

gitlab user --only=id,email,name

gitlab users --except=id,email,name

WARNING

Before executing destructive commands you will be prompted to confirm them.

Additional commands

help lists all available actions

shell runs a shell to perform commands

info gives information about the environment

-v or --version shows the gem version

Shell

You can perform commands in an interactive gitlab shell by running gitlab shell

gitlab shell

# list available commands
gitlab> help

# list groups
gitlab> groups

# protect a branch
gitlab> protect_branch 1 master

# quit shell
gitlab> exit

You can hit tab for command completion.