<commit_before><h1 align="left">
  <br>
  <img width="300" src="https://raw.githubusercontent.com/microplan-xyz/microplan/master/images/logo_black.png" alt="microplan">
  <br>
</h1>

Plan your projects from the command line

[![Build Status](https://semaphoreci.com/api/v1/scriptnull/microplan/branches/master/badge.svg)](https://semaphoreci.com/scriptnull/microplan)
[![npm version](https://badge.fury.io/js/microplan.svg)](https://badge.fury.io/js/microplan)
[![npm](https://img.shields.io/npm/dm/microplan.svg)](https://www.npmjs.com/package/microplan)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/microplan-xyz/microplan/blob/master/LICENSE)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/microplan-xyz/Lobby)

### Inspiration
> "I am a strong believer that great software comes from great people. If you worry only about the technology side of the equation, you're missing way more than half of the picture"
>
> -- <NAME> (  "Evolutionary Architect", Building Microservices)

We want to solve the "Planning" side of the equation. And we want our tool to be handy. Talking of handy tools, the terminal comes to mind. So why not use that as our playground?

### Installation
Microplan requires Node.js 0.12 or greater along with npm

```bash
$ npm install -g microplan
```

### Planning Tools
The following issue trackers/messaging tools are supported by microplan.

| Tool | Status |
|------|--------|
| [Github](https://github.com/) | AVAILABLE   |
| [Gitlab](https://gitlab.com/) | AVAILABLE   |
| [Gitter](https://gitter.im)   | AVAILABLE   |

### Getting Started
Let's say you want to create a user registration form in your app. Your workflow might look something like this:

- Ping the UX team on Slack/Gitter to ask how the UI should look like
- Open an issue in the front-end repo (on GitHub) to add a page and notify about it (on Gitter)
- Open another issue in the back-end repo (on GitLab ) to add an API endpoint

Wait. This seems all over the place! :O

What if you had a consolidated solution baked right into your terminal?

This is where microplan comes into the picture! Let's get started and publish this plan to the specified tools from the cozy comfort of your command line.

### Login
Use the `login` command to store your credentials in the `.microplan` file in your HOME folder

- Generate your GitHub `token` [here](https://github.com/settings/tokens)
- Generate your GitLab `token` [here](https://gitlab.com/profile/personal_access_tokens)
- Gitter uses a custom integration URL specified in the planning file (details to follow below)

```bash
$ microplan login
```

![anim](https://cloud.githubusercontent.com/assets/4211715/20641564/9cca34f2-b420-11e6-8155-8080fc33faa8.gif)

### Initialize
`init` creates a file to help you get started with the planning flow

```bash
$ microplan init [filename].yml
```<commit_msg>adds init readme.md update breaking change<commit_after><h1 align="left">
  <br>
  <img width="300" src="https://raw.githubusercontent.com/microplan-xyz/microplan/master/images/logo_black.png" alt="microplan">
  <br>
</h1>

Plan your projects from the command line

[![Build Status](https://semaphoreci.com/api/v1/scriptnull/microplan/branches/master/badge.svg)](https://semaphoreci.com/scriptnull/microplan)
[![npm version](https://badge.fury.io/js/microplan.svg)](https://badge.fury.io/js/microplan)
[![npm](https://img.shields.io/npm/dm/microplan.svg)](https://www.npmjs.com/package/microplan)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/microplan-xyz/microplan/blob/master/LICENSE)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/microplan-xyz/Lobby)

### Inspiration
> "I am a strong believer that great software comes from great people. If you worry only about the technology side of the equation, you're missing way more than half of the picture"
>
> -- <NAME> (  "Evolutionary Architect", Building Microservices)

We want to solve the "Planning" side of the equation. And we want our tool to be handy. Talking of handy tools, the terminal comes to mind. So why not use that as our playground?

### Installation
Microplan requires Node.js 0.12 or greater along with npm

```bash
$ npm install -g microplan
```

### Planning Tools
The following issue trackers/messaging tools are supported by microplan.

| Tool | Status |
|------|--------|
| [Github](https://github.com/) | AVAILABLE   |
| [Gitlab](https://gitlab.com/) | AVAILABLE   |
| [Gitter](https://gitter.im)   | AVAILABLE   |

### Getting Started
Let's say you want to create a user registration form in your app. Your workflow might look something like this:

- Ping the UX team on Slack/Gitter to ask how the UI should look like
- Open an issue in the front-end repo (on GitHub) to add a page and notify about it (on Gitter)
- Open another issue in the back-end repo (on GitLab ) to add an API endpoint

Wait. This seems all over the place! :O

What if you had a consolidated solution baked right into your terminal?

This is where microplan comes into the picture! Let's get started and publish this plan to the specified tools from the cozy comfort of your command line.

### Login
Use the `login` command to store your credentials in the `.microplan` file in your HOME folder

- Generate your GitHub `token` [here](https://github.com/settings/tokens)
- Generate your GitLab `token` [here](https://gitlab.com/profile/personal_access_tokens)
- Gitter uses a custom integration URL specified in the planning file (details to follow below)

```bash
$ microplan login
```

![anim](https://cloud.githubusercontent.com/assets/4211715/20641564/9cca34f2-b420-11e6-8155-8080fc33faa8.gif)

### Initialize
`init` creates a file to help you get started with the planning flow

```bash
$ microplan init [filename].yml

$ microplan init --help

  Usage: microplan-init [options]

  Options:

    -t, --template <location>   specify input template location
    -d, --directory <location>  specify plan output directory
    -h, --help                  output usage information

```
{'fraction_non_alphanumeric': 0.12544744549300357, 'fraction_numerical': 0.01464367068011715, 'mean_word_length': 4.24935952177626, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 23, 'https://': 34, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6356114', 'n_tokens_mistral': 2028, 'n_tokens_neox': 1860, 'n_words': 651}