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]
glab mr [list, create, close, reopen, delete, ...]
glab issue [list, create, close, reopen, delete, ...]
glab pipeline [list, delete, ci status, ci view, ...]
glab release
glab repo
glab label
glab alias
$ 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.
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]
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 bash
or
curl -s https://raw.githubusercontent.com/profclems/glab/trunk/scripts/quick_install.sh | sudo bash
Installs 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. Download and install now at the releases page.
The installable executable file sets the PATH automatically.
scoop bucket add profclems-bucket https://github.com/profclems/scoop-bucket.git
scoop install glab
Downloads available via linuxbrew (homebrew) and tar balls
brew install profclems/tap/glab
Updating:
brew upgrade glab
glab
is available through the gitlab-glab-bin package on the AUR.
Download the tar ball, untar and install:
- Download the
.tar.gz
file from the releases page unzip glab-*-linux-amd64.tar.gz
to unzip the downloaded filesudo mv glab-*-linux-amd64/glab /usr/bin
glab
is available via Homebrew or you can manually install
brew install profclems/tap/glab
Updating:
brew upgrade glab
- Download the
.tar.gz
or.zip
file from the releases page and unzip or untar - ls /usr/local/bin/ || sudo mkdir /usr/local/bin/; to make sure the bin folder exists
sudo mv glab-*-darwin-amd64/glab /usr/bin
If a supported binary for your OS is not found at the releases page, you can build from source:
-
Verify that you have Go 1.13.8+ installed
$ go version go version go1.14
If
go
is not installed, follow instructions on the Go website. -
Clone this repository
$ git clone https://github.com/profclems/glab.git glab-cli $ cd glab-cli
or
$ git clone https://gitlab.com/profclems/glab.git $ cd glab-cli
-
Build the project
$ make build
-
Move the resulting
bin/glab
executable to somewhere in your PATH$ sudo mv ./bin/glab /usr/local/bin/
or
$ sudo mv ./bin/glab /usr/bin/
-
Run
glab version
to check if it worked andglab config -g
to 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.
glab config init # Will be prompted for details and stored in the global directory
To set configuration globally
glab config set -g token xxxxxx --host=gitlab.com
To set configuration for current directory (must be a git repository)
glab config set token xxxxxx --host=gitlab.com
glab config
NB: Change gitlab.com to company or group's gitlab url (eg. gitlab.example.com) if self-hosted
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 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
Aside adding more features, the biggest thing this tool still needs is tests π
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
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
Copyright Β© Clement Sam
glab
is open-sourced software licensed under the MIT license.