niklastreml / gitlab-tui

A terminal based UI for interacting with your gitlab issues and merge requests

Gitlab TUI 🚀

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

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.

gitlab-tui's Issues

Feat: Fetch real data from gitlab api

Currently the app uses hardcoded example data. Instead, it should fetch actual live data from a gitlab instance. This issue will serve as a tracking issue.

Todo

• Authentication
  • Get Gitlab instance from configured remote
  • Use token in ~/.netrc
• Data fetching
  • Evaluate whether we can listen to events, otherwise routinely fetch data
  • Implement data fetching

Feat: Basic UI

Create a basic ui that shows an overview of merge requests and issues. It should also be possible to read discussions under issues and merge requests.

• Drawing
  • List of issues
  • List of merge requests
  • Issue details
  • Merge request details

Merge request/Issue url in details page

The app should display the url to the issue/mr in the details page

Show related events in details

Feature

Use notes api and other event apis to display notes and related events to mrs/issues in details. Similar to how the gitlab website shows all kinds of related events, like mentioning an issue or opening an mr.

Related links

https://docs.gitlab.com/ee/api/notes.html
https://docs.gitlab.com/ee/api/notes.html#resource-events

Display errors

The app should have a way of showing error messages to the user

Show some details about project on root screen

Instead showing a lot of empty boxes when intially launching, we could display some of the info about the project that we can get from gitlab, like the name and description

Feat: Pick remote

When multiple remotes are configured for a repository, the user should be able to choose the remote the want to use. If the remote origin is not a valid gitlab instance, instead of shutting down, we should either display an error if it's the only configured remote, or the user should be able to pick one of the existing ones