cli/docs/source/index.md

2.2 KiB

stage group info
Create Code Review To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments

GitLab CLI - glab

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.

command example

The GitLab CLI uses commands structured like glab <command> <subcommand> [flags] to perform many of the actions you normally 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

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.

Report issues

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