glap 0.1.4

A GitLab Artifact Puller / Downloader

glap

A GitLab Artifact Puller / Downloader

Quick Start

glap is a convenience tool to download artifacts of your frequently used GitLab repositories. Install via

pip install glap

Before you can use glap, you have to setup your configuration file located at ~/.config/glap/glap.toml. It contains the following information.

• Remotes with corresponding urls and access-tokens (token):

[remotes.myremote]
url = "https://gitlab.com"
token = "<my-access-token>"

• Shortcuts for specific repositories. For example, the following shortcut points at the PDFs job of the main branch of https://gitlab.com/name/repo.

[shortcuts.myshortcut]
remote = "myremote"
namespace = "name"
repository = "repo"
branch = "main"
job = "PDFs"

Any configured shortcut will appear as a subcommand, i.e. you can use it as follows

glap myshortcut

Alternatively, you can specify the namespace and repository directly

glap download <namespace> <repository>

If no remote is given, glap will use the first one in the configuration file. Otherwise, you can use

glap download <namespace> <repository> -r myremote

where myremote is the name of the remote in the configuration file.

Options

• --job (-j) specifies the job's name.
• --branch (-b) specifies the branch's name.
• --output (-o) specifies the download location.
• --temp (-t) downloads the artifact to a temporary location and opens the directory.