README.md in gl-0.3.1 vs README.md in gl-0.4.0
- old
+ new
@@ -1,7 +1,24 @@
# Gl
+- [Gl](#gl)
+ * [Installation](#installation)
+ * [Usage](#usage)
+ + [Issues](#issues)
+ - [List](#list)
+ - [Open](#open)
+ + [Merge Requests](#merge-requests)
+ - [Interactive](#interactive)
+ - [List](#list-1)
+ - [Open](#open-1)
+ - [Approve](#approve)
+ - [Merge](#merge)
+ + [Registry](#registry)
+ * [Development](#development)
+ * [Contributing](#contributing)
+ * [License](#license)
+
Gl is a small CLI that hooks into your Git config and GitLab API to easily access information based
on the project your are currently in.
## Installation
@@ -20,10 +37,12 @@
gl issues # handle issues of the project
gl mr # handle merge requests of the project
gl registry # handle registry of the project
```
+### Issues
+#### List
```bash
$ gl issues list
+-----+----------------+-------------------------------------------------------------------------------+
| IID | Author | Title |
@@ -32,46 +51,88 @@
| 105 | XXXXXXXXXXXXXX | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| 44 | XXXXXXXXXXXXXX | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| 33 | XXXXXXXXXXXXXX | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
+-----+----------------+-------------------------------------------------------------------------------+
```
-
+With interactive switch
```bash
-$ gl mr list
-
-+-----+--------------+-------------------------------------------------------------------------------+
-| IID | Author | Title |
-+-----+--------------+-------------------------------------------------------------------------------+
-| 268 | XXXXXXXXXXXX | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
-| 264 | XXXXXXXXXXXX | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
-| 217 | XXXXXXXXXXXX | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
-| 213 | XXXXXXXXXXXX | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
-| 188 | XXXXXXXXXXXX | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
-+-----+--------------+-------------------------------------------------------------------------------+
-```
-
-Both commands offer a interactive switch which opens the selected merge request/issue after selecting:
-
-```bash
$ gl issues list -i
Open a issue (Use ↑/↓ and ←/→ arrow keys, press Enter to select)
‣ 409 - XXXXXXXXXXXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
408 - XXXXXXXXXXXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
407 - XXXXXXXXXXXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
406 - XXXXXXXXXXXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
405 - XXXXXXXXXXXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
404 - XXXXXXXXXXXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
+#### Open
+Open a issue directly with the IID or viathe interactive list
+```bash
+$ gl issue open 409
+```
-Your can also directly open an issue or merge request with a IID:
+### Merge Requests
+#### Interactive
+```bash
+$ gl mr list -i
+Select a merge request (Use ↑/↓ arrow keys, press Enter to select, and letter keys to filter)
+‣ 2 - robert.mueller - WIP: Update README.md
+```
+
+In interactive mode you can also perform all the other actions
```bash
-$ gl issue open 409
-# or
-$ gl mr open 213
+$ gl mr list -i
+
+Select a merge request 2 - robert.mueller - WIP: Update README.md
+┌────────────────────────────────────────WIP: Update README.md─────────────────────────────────────────┐
+│ │
+│ # Nec verum procul trahuntur velle │
+│ │
+│ ## Foedantem blandis malorum mox │
+│ │
+│ chipsetMyspace.perlUltra.font_document(iscsiStandbyPermalink( │
+│ computing_mac_modem, streamingSli)); │
+│ address_operating = 40 + binComputingTransistor + rw * minimize; │
+│ wired(-1, qbe_export); │
+│ │
+└State: opened────────────────────────────────────────────────────────────────────────by robert.mueller┘
+What to do next? (Use ↑/↓ arrow keys, press Enter to select)
+‣ open
+ merge
+ approve
+ exit
+
```
+#### List
+```bash
+$ gl mr list
+
++-----+----------------+-----------------------+
+| IID | Author | Title |
++-----+----------------+-----------------------+
+| 2 | robert.mueller | WIP: Update README.md |
++-----+----------------+-----------------------+
+```
+
+#### Open
+```bash
+$ gl mr open 2
+```
+
+#### Approve
+```bash
+$ gl mr approve 2
+```
+
+#### Merge
+```bash
+$ gl mr merge 2
+```
+
+### Registry
With the registry subcommand you can get a overview about the registry usage.
```bash
$ gl registry status