An open API service indexing awesome lists of open source software.

https://github.com/ramongebben/mergify

A very small cli for looking at Gitlab merge requests
https://github.com/ramongebben/mergify

cli gitlab gitlab-cli merge-request

Last synced: 12 months ago
JSON representation

A very small cli for looking at Gitlab merge requests

Awesome Lists containing this project

README

          

# Mergify
A very simple cli to check merge requests on Gitlab.

![npm](http://img.shields.io/npm/v/@pindakaasman/mergify.svg)
[![Build Status](https://travis-ci.org/RamonGebben/mergify.svg?branch=master)](https://travis-ci.org/RamonGebben/mergify)
[![Coverage Status](https://coveralls.io/repos/github/RamonGebben/mergify/badge.svg?branch=master)](https://coveralls.io/github/RamonGebben/mergify?branch=master)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pindakaasman/mergify/badge.svg)](https://snyk.io/test/npm/@pindakaasman/mergify)

## Install

```
yarn global add @pindakaasman/mergify
```

## Usage

Just grab up the help menu by using `mergify --help` and you will be presented with the help dialog.
```
Usage: mergify [options]

Options:

-V, --version output the version number
-a --assigned Get all open merge request assigned to you
-s --submitted Get all open merge request submitted to you
-c --configure Setup or update required config
-v --verify Verify your config is correct
-h, --help output usage information
```

## Configure

To complete setup you will need to run the `configure` command to provide access to the Gitlab API.

```
mergify --configure
```

### Finding your userid

You Gitlab `userid` is **not** your `username`!

You can find your `userid` by going to [the profile page](https://gitlab.com/profile).
It will be located on the right.

![Example of userid](https://user-images.githubusercontent.com/921666/38989234-6d7ff064-43d6-11e8-8758-f90bddf7dbe5.png)

### Getting a Gitlab access token

Complete documentation on how to get a private token can be [found at Gitlab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html).

You will need to go to you [access tokens page](https://gitlab.com/profile/personal_access_tokens) and provide at least **api** access.

See Screenshot for an example of access token creation :

screen shot 2018-04-20 at 1 09 40 pm