zemzale/glab

GLab

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. Inspired by gh, the official GitHub CLI tool.

glab is available for repositories hosted on GitLab.com and self-hosted GitLab Instances. glab supports multiple authenticated GitLab instances and automatically detects the authenticated hostname from the remotes available in the working git directory.

Verify that you have Go 1.13+ 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
cd glab
```
If 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
```
Change PATH to find newly compiled glab
```
export PATH=$PWD/bin:$PATH
```
Run glab version to confirm that it worked

Authentication

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 xxxxx
```

Configuration

By default, glab follows the XDG Base Directory Spec: global configuration file is saved at ~/.config/glab-cli. Local configuration file is saved at .git/glab-cli in the current working git directory. Advanced workflows may override the location of the global configuration by setting the GLAB_CONFIG_DIR environment variable.

To set configuration globally

glab config set --global editor vim

To set configuration for current directory (must be a git repository)

glab config set editor vim

To 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.org

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 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.

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 URL

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.

FORCE_HYPERLINKS: set to 1 to force hyperlinks to be output, even when not outputing to a TTY

What about Lab?

Both glab and lab are open-source tools with the same goal of bringing GitLab to your command line and simplifying the developer workflow. In many ways lab is to hub, while glab is to gh.

If you want a tool that’s more opinionated and intended to help simplify your GitLab workflows from the command line, then glab is for you. However, If you're looking for a tool like hub that feels like using git and allows you to interact with GitLab, you might consider using lab.

Some glab commands such as ci view and ci trace were adopted from lab.

Issues

If you have an issue: report it on the issue tracker

Contributing

Feel like contributing? That's awesome! We have a contributing guide and Code of conduct to help guide you

Contributors

Individuals

This project exists thanks to all the people who contribute. [Contribute].

Organizations

License

glab is open-sourced software licensed under the MIT license.

zemzale/glab

GLab

Table of Contents

Usage

Demo

Documentation

Installation

Quick Install

Homebrew

Windows

WinGet

Scoop

EXE Installer

Linux

Linuxbrew (Homebrew)

Snapcraft

Arch Linux

KISS Linux

Alpine Linux

Install

Install a pinned version from edge

Alpine Linux Docker-way

Nix/NixOS

macOS