GitLab CLI - glab

DETAILS: Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

GLab is an open source GitLab CLI tool. It brings GitLab to your terminal: next to where you are already working with Git and your code, without switching between windows and browser tabs.

• Work with issues.
• Work with merge requests.
• Watch running pipelines directly from your CLI.

The GitLab CLI uses commands structured like glab <command> <subcommand> [flags] to perform many of the actions you usually do from the GitLab user interface:

# Sign in
glab auth login --stdin < token.txt

# View a list of issues
glab issue list

# Create merge request for issue 123
glab mr for 123

# Check out the branch for merge request 243
glab mr checkout 243

# Watch the pipeline in progress
glab pipeline ci view

# View, approve, and merge the merge request
glab mr view
glab mr approve
glab mr merge

Core commands

• glab alias
• glab api
• glab ask
• glab auth
• glab changelog
• glab check-update
• glab ci
• glab cluster
• glab completion
• glab config
• glab incident
• glab issue
• glab label
• glab mr
• glab release
• glab repo
• glab schedule
• glab snippet
• glab ssh-key
• glab user
• glab variable

GitLab Duo commands

The GitLab CLI also provides support for GitLab Duo AI/ML powered features. These include:

• glab ask

Use glab ask to ask questions about git commands. It can help you remember a command you forgot, or provide suggestions on how to run commands to perform other tasks.

Install the CLI

Installation instructions are available in the glab README.

Authenticate with GitLab

To authenticate with your GitLab account, run glab auth login. glab respects tokens set using GITLAB_TOKEN.

glab also integrates with the 1Password shell plugin for secure authentication.

Report issues

Open an issue in the gitlab-org/cli repository to send us feedback.

Related topics

• Install the CLI
• Documentation
• Extension source code in the cli project

Troubleshooting

glab completion commands fail when using the 1Password shell plugin

The 1Password shell plugin adds the alias glab='op plugin run -- glab', which can interfere with the glab completion command. If your glab completion commands fail, configure your shell to prevent expanding aliases before performing completions:

• For Zsh, edit your ~/.zshrc file and add this line:

  setopt completealiases

• For Bash, edit your ~/.bashrc file and add this line:

  complete -F _functionname glab

For more information, see issue 122 for the 1Password shell plugin.