GLab is an open source GitLab CLI tool bringing 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, merge requests, watch running pipelines directly from your CLI among other features.
glab is available for repositories hosted on GitLab.com and self-managed GitLab instances. glab supports multiple authenticated GitLab instances and automatically detects the authenticated hostname from the remotes available in the working Git directory.
Table of contents
- Table of contents
- Usage
- Demo
- Documentation
- Installation
- Authentication
- Configuration
- Environment variables
- Issues
- Contributing
Usage
To get started with glab:
- Follow the installation instructions appropriate for your operating system.
- Authenticate into your instance of GitLab.
- Optional. Configure
glabfurther to meet your needs:- Set any needed global, per-project, or per-host configuration.
- Set any needed environment variables.
You’re ready! Run glab --help to view a list of core commands. Commands follow this pattern:
glab <command> <subcommand> [flags]
Many core commands also have sub-commands. Some examples:
- List merge requests assigned to you:
glab mr list --assignee=@me - List review requests for you:
glab mr list --reviewer=@me - Approve a merge request:
glab mr approve 235 - Create an issue, and add milestone, title, and label:
glab issue create -m release-2.0.0 -t "My title here" --label important
Demo
Documentation
Read the documentation for usage instructions or check out glab help.
Installation
Download a binary suitable for your OS at the releases page. Other installation methods depend on your operating system.
macOS
- Homebrew (officially supported)
- Install with:
brew install glab - Update with:
brew upgrade glab
- Install with:
- MacPorts:
- Install with:
sudo port install glab - Update with:
sudo port selfupdate && sudo port upgrade glab
- Install with:
-
Install into
usr/binwith a shell script:curl -s "https://gitlab.com/gitlab-org/cli/-/raw/main/scripts/install.sh" | sudo shBefore running any install script, review its contents.
Windows
- WinGet
- Install with:
winget install glab.glab - Update with:
winget install glab.glab
- Install with:
- scoop
- Install with:
scoop install glab - Update with:
scoop update glab
- Install with:
- Download an EXE installer or the
glab.exebinary from the releases page
Linux
- Download prebuilt binaries from the releases page
Homebrew
Installing from Homebrew is the officially supported installation method for Linux.
- Install with:
brew install glab - Update with:
brew upgrade glab
Snapcraft (out of date)
To install glab from the Snap Store:
- Make sure you have snap installed on your Linux distribution.
- Install the package:
sudo snap install --edge glab - Grant
glabaccess to SSH keys:sudo snap connect glab:ssh-keys
Arch Linux
For Arch Linux, glab is available:
- From the
community/glabpackage. - By downloading and installing an archive from the releases page.
- From the Snap Store, if snap is installed.
- Installing with the package manager:
pacman -S glab
Alpine Linux
glab is available on the Alpine Community Repository as glab.
When installing, use --no-cache so no apk update is required:
apk add --no-cache glab
Install a pinned version from edge
To ensure that by default edge is used to get the latest updates. We need the edge repository in /etc/apk/repositories.
Afterwards you can install it with apk add --no-cache glab@edge
We use --no-cache so an apk update is not required.
echo "@edge http://dl-cdn.alpinelinux.org/alpine/edge/community" >> /etc/apk/repositories
apk add --no-cache glab@edge
Alpine Linux Docker-way
Use edge directly
FROM alpine:3.13
RUN apk add --no-cache glab
Fetching latest glab version from edge
FROM alpine:3.13
RUN echo "@edge http://dl-cdn.alpinelinux.org/alpine/edge/community" >> /etc/apk/repositories
RUN apk add --no-cache glab@edge
Nix/NixOS
Nix (NixOS) users can install from nixpkgs with the command nix-env -iA nixos.glab.
MPR (Debian/Ubuntu)
glab is available inside the makedeb package repository. To install, run the following:
git clone 'https://mpr.makedeb.org/glab'
cd glab/
makedeb -si
Prebuilt-MPR
The above method downloads glab from source and builds it before packaging it into a .deb package. If you don’t want to compile or just want a prebuilt package, you can also install glab from the Prebuilt-MPR:
- Set up the Prebuilt-MPR on your system.
- Install with the command
sudo apt install glab.
Spack
- To install:
spack install glab. - To update:
spack uninstall glab && spack install glab
Building from source
If a supported binary for your OS is not found at the releases page, you can build from source:
Prerequisites for building from source
make- Go 1.18+
To build from source:
- Run the command
go versionto verify that Go version 1.18 or later is installed. Ifgois not installed, follow instructions on the Go website. - Clone this repository:
git clone https://gitlab.com/gitlab-org/cli.git glab - Change into the project directory:
cd glab - If you have
$GOPATH/binor$GOBINin your$PATH, runmake installto install in$GOPATH/bin). - If you do not have
$GOPATH/binor$GOBINin your$PATH:- Run
maketo build the project. - Run
export PATH=$PWD/bin:$PATHto update your PATH with the newly compiled project.
- Run
- Run
glab versionto confirm that it worked.
Authentication
To authenticate your installation of glab:
- Get a GitLab personal access token with at least the
apiandwrite_repositoryscopes. Use the method appropriate for your instance:- For GitLab.com, create one at the Personal access tokens page.
- For self-managed instances, visit
https://gitlab.example.com/-/profile/personal_access_tokens, modifyinggitlab.example.comto match the domain name of your instance.
- Start interactive setup:
glab auth login - Authenticate with the method appropriate for your GitLab instance:
- For GitLab SaaS, authenticate against
gitlab.comby reading the token from a file:glab auth login --stdin < myaccesstoken.txt - For self-managed instances, authenticate by reading from a file:
glab auth login --hostname salsa.debian.org --stdin < myaccesstoken.txt - Authenticate with token and hostname:
glab auth login --hostname gitlab.example.org --token xxxxxNot recommended for shared environments.
- For GitLab SaaS, authenticate against
Configuration
By default, glab follows the
XDG Base Directory Spec.
Configure it globally, locally, or per-host:
- Globally: run
glab config set --global editor vim.- The global configuration file is available at
~/.config/glab-cli. - To override this location, set the
GLAB_CONFIG_DIRenvironment variable.
- The global configuration file is available at
- The current directory: run
glab config set editor vimin any folder in a Git repository.- The local configuration file is available at
.git/glab-cliin the current working Git directory.
- The local configuration file is available at
- Per host: run
glab config set editor vim --host gitlab.example.org, changing the--hostparameter to meet your needs.- Per-host configuration info is always stored in the global configuration file, with or without the
globalflag.
- Per-host configuration info is always stored in the global configuration file, with or without the
Environment variables
GITLAB_TOKEN: an authentication token for API requests. Setting this avoids being prompted to authenticate and overrides any previously stored credentials. Can be set in the config withglab config set token xxxxxxGITLAB_URIorGITLAB_HOST: specify the URL of the GitLab server if self-managed (eg:https://gitlab.example.com). Default ishttps://gitlab.com.GITLAB_API_HOST: specify the host where the API endpoint is found. Useful when there are separate (sub)domains or hosts for Git and the API endpoint: defaults to the hostname found in the Git URLGITLAB_REPO: Default GitLab repository used for commands accepting the--repooption. Only used if no--repooption is given.GITLAB_GROUP: Default GitLab group used for listing merge requests, issues and variables. Only used if no--groupoption is given.REMOTE_ALIASorGIT_REMOTE_URL_VAR:git remotevariable or alias that contains the GitLab URL. Can be set in the config withglab config set remote_alias originVISUAL,EDITOR(in order of precedence): the editor tool to use for authoring text. Can be set in the config withglab config set editor vimBROWSER: the web browser to use for opening links. Can be set in the configuration withglab config set browser mybrowserGLAMOUR_STYLE: environment variable to set your desired Markdown renderer style Available options are (dark|light|notty) or set a custom styleNO_COLOR: set to any value to avoid printing ANSI escape sequences for color output.FORCE_HYPERLINKS: set to1to force hyperlinks to be output, even when not outputting to a TTY
stage: Create group: Code Review info: 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.
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
glab aliasglab apiglab authglab ciglab issueglab labelglab mrglab projectglab releaseglab snippetglab ssh-keyglab userglab variable
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.
Related topics
- Install the CLI
- Documentation
- The extension source code is available in the
cliproject.
Clone With Gitlab Self Hosted (PoC)
- glab auth login
- select self hosted
- using https method and your token access
- use the command below
GITLAB_HOST=GITLAB_SELF_HOSTED glab repo clone groupname/path/project_name
GITLAB_HOST=GITLAB_SELF_HOSTED glab repo clone yourgitlabname/project_name
- Clone by group subdir with namespace
GITLAB_HOST=GITLAB_SELF_HOSTED glab repo clone -g groupname/subdir -paginate
- Clone all by group name with namespace
GITLAB_HOST=GITLAB_SELF_HOSTED glab repo clone -g groupname -p
- Cloner all and subdir by group name with namespace
GITLAB_HOST=GITLAB_SELF_HOSTED glab repo clone -g groupname/subdir/pathname -pRefferences :
- Install: https://gitlab.com/gitlab-org/cli/#installation
- CLI : https://gitlab.com/gitlab-org/cli/-/blob/main/docs/source/repo/clone.md
- Demo : https://asciinema.org/a/368622
