GLab is an open source Gitlab Cli tool written in Go (golang) to help work seamlessly with Gitlab from the command line. Work with issues, merge requests, watch running pipelines directly from your CLI among other features.
Inspired by gh, the official GitHub CLI tool.
glab <command> <subcommand> [flags] auth: Manage glab's authentication state
issue: Work with GitLab issues
label: Manage labels on remote
mr: Create, view and manage merge requests
pipeline: Manage pipelines
release: Manage GitLab releases
repo: Work with GitLab repositories and projects
alias: Create, list and delete aliases
check-update: Check for latest glab releases
completion: Generate shell completion scripts
config: Set and get glab settings
help: Help about any command
version: show glab version information$ glab issue create --title="This is an issue title" --description="This is a really long description"
$ glab issue list --closed
$ glab pipeline ci view -b master # to watch the latest pipeline on master
$ glab pipeline status # classic ci view
Read the documentation for more information on this tool.
Download a binary suitable for your OS at the releases page.
You can install or update glab with:
curl -sL https://j.mp/glab-i | sudo bashor
curl -s https://raw.githubusercontent.com/profclems/glab/trunk/scripts/quick_install.sh | sudo bashInstalls into usr/local/bin
NOTE: Please take care when running scripts in this fashion. Consider peaking at the install script itself and verify that it works as intended.
Available for download on scoop or manually as an installable executable file or a Portable archived file in tar and zip formats at the releases page.
scoop bucket add profclems-bucket https://github.com/profclems/scoop-bucket.git
scoop install glabUpdating:
scoop update glabPrebuilt binaries available at the releases page.
brew install glabUpdating:
brew upgrade glab
Make sure you have snap installed on your Linux Distro (https://snapcraft.io/docs/installing-snapd).
sudo snap install --edge glabsudo snap connect glab:ssh-keysto grant ssh access
glab is available through the gitlab-glab-bin package on the AUR or download and install an archive from the releases page. Arch Linux also supports snap.
pacman -Sy gitlab-glab-binglab is available on the KISS Linux Community Repo as gitlab-glab.
If you already have the community repo configured in your KISS_PATH you can install glab through your terminal.
kiss b gitlab-glab && kiss i gitlab-glabIf you do not have the community repo configured in your KISS_PATH, follow the guide on the official guide Here to learn how to setup it up.
glab is available via Homebrew
brew install glabUpdating:
brew upgrade glabIf a supported binary for your OS is not found at the releases page, you can build from source:
make- Go 1.13+
-
Verify that you have Go 1.13+ installed
$ go version go version go1.14
If
gois not installed, follow instructions on the Go website. -
Clone this repository
$ git clone https://github.com/profclems/glab.git $ cd glabIf you have $GOPATH/bin or $GOBIN in your $PATH, you can just install with
make install(install glab in $GOPATH/bin) and skip steps 3 and 4. -
Build the project
$ make -
Move the resulting
bin/glabexecutable to somewhere in your PATH$ sudo mv ./bin/glab /usr/local/bin/
-
Run
glab versionto check if it worked andglab config initto set up
Get a GitLab access token at https://gitlab.com/profile/personal_access_tokens or https://gitlab.example.com/profile/personal_access_tokens if self-hosted
- start interactive setup
$ glab auth login- authenticate against gitlab.com by reading the token from a file
$ glab auth login --stdin < myaccesstoken.txt- authenticate against a self-hosted GitLab instance by reading from a file
$ glab auth login --hostname salsa.debian.org --stdin < myaccesstoken.txt- authenticate with token and hostname (Not recommended for shared environments)
$ glab auth login --hostname gitlab.example.org --token xxxxxglab follows the XDG Base Directory Spec: global configuration file is saved at ~/.config/glab-cli. Local configuration file is saved at the root of the working git directory and automatically added to .gitignore.
To set configuration globally
$ glab config set --global editor vimTo set configuration for current directory (must be a git repository)
$ glab config set editor vimTo set configuration for a specific host
Use the --host flag to set configuration for a specific host. This is always stored in the global config file with or without the global flag.
$ glab config set editor vim --host gitlab.example.orgGITLAB_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 with 'glab config set token xxxxxx'
GITLAB_URI or GITLAB_HOST: specify the url of the gitlab server if self hosted (eg: https://gitlab.example.com). Default is https://gitlab.com.
REMOTE_ALIAS or GIT_REMOTE_URL_VAR: git remote variable or alias that contains the gitlab url.
Can be set in the config with 'glab config set remote_alias origin'
VISUAL, EDITOR (in order of precedence): the editor tool to use for authoring text.
Can be set in the config with 'glab config set editor vim'
BROWSER: the web browser to use for opening links.
Can be set in the config with 'glab config set browser mybrowser'
GLAMOUR_STYLE: environment variable to set your desired markdown renderer style
Available options are (dark|light|notty) or set a custom style
https://github.com/charmbracelet/glamour#styles
NO_COLOR: set to any value to avoid printing ANSI escape sequences for color output. If you have an issue: report it on the issue tracker
Feel like contributing? That's awesome! We have a contributing guide and Code of conduct to help guide you
By donating $5 or more you can support the ongoing development of this project. We'll appreciate some support. Thank you to all our supporters! 🙏 [Contribute]
This project exists thanks to all the people who contribute. [Contribute].
Thank you to all our backers! 🙏 [Become a backer]
Copyright © Clement Sam
glab is open-sourced software licensed under the MIT license.