https://github.com/plapadoo/gitlab-simple

A simple CLI interface to GitLab
https://github.com/plapadoo/gitlab-simple

cli command-line-tool gitlab

Last synced: about 1 month ago
JSON representation

A simple CLI interface to GitLab

• Host: GitHub
• URL: https://github.com/plapadoo/gitlab-simple
• Owner: plapadoo
• License: gpl-3.0
• Created: 2018-09-20T11:03:17.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-11-08T10:55:46.000Z (about 6 years ago)
• Last Synced: 2024-10-10T09:21:34.855Z (3 months ago)
• Topics: cli, command-line-tool, gitlab
• Language: Python
• Size: 93.8 KB
• Stars: 1
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
* What’s this?

[[./example.png]]

This tool provides a really simple command line interface to common GitLab operations. Supported are:

 - List issues in a project (filter by assignee)

 - Close issues

 - Create new issues

 - Edit issues

 - Assign issues

 - Comment on issues

 - Create new snippets

* Installation

The project has a standard Python project layout, so =python setup.py install= should work.

If you’re using nix, =nix-build= works as well.

* Configuration

You need a so-called “Personal Access Token” for GitLab in order to use this tool. [[https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html][This page]] describes in detail how to get one (it’s pretty simple). Once you have it, create the file =~/.config/gitlab-simple/config.json= with the following content:

#+BEGIN_SRC json

{

    "server": "https://gitlab.com",

    "token": "your token here"

}

#+END_SRC

If you’re self-hosting GitLab, feel free to change the URL accordingly. Also, if you have just one project you’re working on, you can specify it in the config file:

#+BEGIN_SRC json

{

    "server": "https://gitlab.com",

    "token": "your token here",

    "project": "58"

}

#+END_SRC

The project ID can be found by clicking on a project in the overview and then looking below the project’s avatar, or by using =--list-projects=.

* Usage

If you don’t have a project specified in the configuration file, you have to pass the =--project= flag, specifying the project ID. You can also set the =GITLAB_SIMPLE_PROJECT= environment variable (which is pretty handy when combined with [[https://direnv.net/][direnv]]).

The command line parmeters can be discovered using =--help= on the command line. I hope everything is self-explanatory, though.