gitlab-tui

Crates.iogitlab-tui
lib.rsgitlab-tui
version0.1.2
sourcesrc
created_at2023-07-11 23:39:52.123711
updated_at2023-07-12 11:44:46.289818
descriptionA terminal based UI for interacting with your gitlab issues and merge requests
homepagehttps://github.com/NiklasTreml/gitlab-tui
repositoryhttps://github.com/NiklasTreml/gitlab-tui
max_upload_size
id914169
size90,358
Niklas Treml (NiklasTreml)

documentation

https://github.com/NiklasTreml/gitlab-tui

README

Gitlab TUI 🚀

Continuous Integration Crates.io

A TUI app for interacting with GitLab issues and merge requests.

image

Installation ⚙️

Cargo 📦

You can use Cargo to download, compile, and install Gitlab TUI on your machine:

cargo install gitlab-tui

Setup 🛠️

To authenticate the GitLab API, Gitlab TUI uses the same .netrc config that Git uses for HTTP cloning. If you have already set up Git with .netrc, there is a good chance it will work immediately. If not, you will need to create one:

  1. Create an API token in GitLab with read-api scope.

  2. Create a .netrc file:

    • On Linux and macOS:

      touch ~/.netrc
      
    • On Windows:

      New-Item ~/.netrc
      
  3. Create an entry for your GitLab instance:

    • For GitLab.com:

      machine gitlab.com
        login __token__
        password <YOUR_TOKEN>
      
    • For self-hosted GitLab:

      machine <YOUR_GITLAB_INSTANCE>
        login __token__
        password <YOUR_TOKEN>
      

That's it! Now just cd into your repo and run gitlab-tui. The program will parse your Git SSH or HTTP remote to figure out the GitLab API URL and fetch all issues and merge requests of your project.

Usage 🚀

The binary is called gitlab-tui. You can bring up the UI by running it without any arguments. If you need to use a different remote than origin, you can use the -r flag to override the remote.

Commit count: 29

cargo fmt