cli-retrospective/README.md

Recall what you did on the last milestone

# cli-retrospective

[![npm version](https://badge.fury.io/js/cli-retrospective.svg)](https://badge.fury.io/js/cli-retrospective)
[![Build Status](https://travis-ci.org/ilbonzo/cli-retrospective.svg?branch=master)](https://travis-ci.org/ilbonzo/cli-retrospective)
[![codecov](https://codecov.io/gh/ilbonzo/cli-retrospective/branch/master/graph/badge.svg)](https://codecov.io/gh/ilbonzo/cli-retrospective)
[![Dependencies Status](https://david-dm.org/ilbonzo/cli-retrospective.svg)](https://david-dm.org/ilbonzo/cli-retrospective)
[![BCH compliance](https://bettercodehub.com/edge/badge/ilbonzo/cli-retrospective?branch=master)](https://bettercodehub.com/)

### A cli tools for restropective

```cli-retrospective``` is a simple command line tools to see the github issues related to a certain milestone when you have to do retrospective.

![image](public/ls-milestone-screen.png)

### Install

```cli-retrospective``` is available on ```npm``` and as such, can be installed through ```npm``` with ease.

To install ```cli-retrospective```, use the following command:

```sh
$ npm install -g cli-retrospective
```

_To configure your access informations run this command and answer the questions:_

```sh
$ cli-retrospective setup
```

### Usage

_view help_
```sh
$ cli-retrospective --help
```

_view subcommand help_
```sh
$ cli-retrospective [subcommand] --help
```

_list of all milestone_
```sh
$ cli-retrospective ls-milestone
```

_view milestone_
```sh
$ cli-retrospective milestone [number]
```
### Running the Tests

```sh
$ npm test
```
### Issues

Please raise an issue on GitHub with as much information as possible and the steps to replicate (if possible).

## LICENSE

MIT license. See the LICENSE file for details.

---
Fork me on [github](https://github.com/ilbonzo/cli-retrospective)

Created by [@ilbonzo](https://twitter.com/ilbonzo)