![kit](http://i.imgur.com/hDtNWrI.jpg)
# kit

A simple command-line tool with a few handy tools, including:

+ generating ASCII art from text
+ verifying package.json dependencies (vs. [rodestead](https://npmjs.com/package/rodestead))



```bash
∑ kit about
•  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •
  ___--¬___
 |~~ ``` ~~|
 |         |
 |_________|
 |_________|

kit vXX.XX.XX
(run kit for usage)

kit is a light-hearted grab bag of command-line utilities.
Feel free to fork, add whatever, and send PRs if you like.
https://github.com/mikermcneil/kit
•  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •
```


## Installation

```bash
∑ npm install -g @mikermcneil/kit
```

## kit

```bash
∑ kit

  Usage: kit [options] <command>


  Commands:

    pkg         show the version of the package in the current directory
    deps        get the install footprint + versions of this package's dependencies
    exclaim     convert a message to ASCII art and copy it to your clipboard
    h1          exclaim a custom heading for your JavaScript code
    h2          exclaim a custom sub-heading for your JavaScript code
    about       what is kit?
    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

```

## kit pkg

```bash
∑ cd /code/sails
∑ kit pkg
-----------------------------------------------------------------
sails
API-driven framework for building realtime apps, using MVC conventions (based on Express and Socket.io)
v0.12.4
MIT License

> http://npmjs.org/package/sails
> http://github.com/balderdashy/sails/
-----------------------------------------------------------------
```



## kit deps


```bash
∑ cd /code/machinepack-fs
machinepack-fs: ∑ kit deps
lodash.isobject@3.0.2                                            ~5.3 KB
lodash.isfunction@3.0.8                                          ~5.96 KB
rttc@9.3.4  (~9.3.0)                                             ~1.06 MB
machine@13.0.0-11                                                ~577.34 KB
walker@1.0.7                                                     ~17.09 KB
machinepack-json@2.0.1  (~2.0.0)                                 ~1.51 MB
machinepack-strings@5.0.0                                        ~2.26 MB
machinepack-util@6.0.1  (~6.0.0)                                 ~2.51 MB
fs-extra@0.30.0                                                  ~317.26 KB

Altogether, dependencies weigh in at ~8.28 MB
(that will take an average of ~4.14 seconds on coffee shop internet)

 (Note that `devDependencies` and `optionalDependencies` were NOT included above.)
```

![](https://cloud.githubusercontent.com/assets/618009/18611825/e7001e56-7d0c-11e6-91b1-30cc4c266d4b.png)



## kit exclaim


```bash
∑ kit exclaim hello world!
-----------------------------------------------------------------
OK, I copied an ASCII-art-ified version of that message to your clipboard:

//  ██╗  ██╗███████╗██╗     ██╗      ██████╗     ██╗    ██╗ ██████╗ ██████╗ ██╗     ██████╗ ██╗
//  ██║  ██║██╔════╝██║     ██║     ██╔═══██╗    ██║    ██║██╔═══██╗██╔══██╗██║     ██╔══██╗██║
//  ███████║█████╗  ██║     ██║     ██║   ██║    ██║ █╗ ██║██║   ██║██████╔╝██║     ██║  ██║██║
//  ██╔══██║██╔══╝  ██║     ██║     ██║   ██║    ██║███╗██║██║   ██║██╔══██╗██║     ██║  ██║╚═╝
//  ██║  ██║███████╗███████╗███████╗╚██████╔╝    ╚███╔███╔╝╚██████╔╝██║  ██║███████╗██████╔╝██╗
//  ╚═╝  ╚═╝╚══════╝╚══════╝╚══════╝ ╚═════╝      ╚══╝╚══╝  ╚═════╝ ╚═╝  ╚═╝╚══════╝╚═════╝ ╚═╝
//
-----------------------------------------------------------------
```

#### Options

```bash
∑ kit exclaim --help

  Usage: kit-exclaim [options]

  Options:

    -h, --help   output usage information
    -a, --args   the serial command-line arguments.
    -w, --width  the width before wrapping.
    -f, --font   the ASCII font to use.

```


#### Headings

```bash
∑ kit exclaim 'find user & populate projects' --width=15
-----------------------------------------------------------------
OK, I copied an ASCII-art-ified version of that message to your clipboard:

//  ███████╗██╗███╗   ██╗██████╗     ██╗   ██╗███████╗███████╗██████╗        ██╗
//  ██╔════╝██║████╗  ██║██╔══██╗    ██║   ██║██╔════╝██╔════╝██╔══██╗       ██║
//  █████╗  ██║██╔██╗ ██║██║  ██║    ██║   ██║███████╗█████╗  ██████╔╝    ████████╗
//  ██╔══╝  ██║██║╚██╗██║██║  ██║    ██║   ██║╚════██║██╔══╝  ██╔══██╗    ██╔═██╔═╝
//  ██║     ██║██║ ╚████║██████╔╝    ╚██████╔╝███████║███████╗██║  ██║    ██████║
//  ╚═╝     ╚═╝╚═╝  ╚═══╝╚═════╝      ╚═════╝ ╚══════╝╚══════╝╚═╝  ╚═╝    ╚═════╝
//
//  ██████╗  ██████╗ ██████╗ ██╗   ██╗██╗      █████╗ ████████╗███████╗
//  ██╔══██╗██╔═══██╗██╔══██╗██║   ██║██║     ██╔══██╗╚══██╔══╝██╔════╝
//  ██████╔╝██║   ██║██████╔╝██║   ██║██║     ███████║   ██║   █████╗
//  ██╔═══╝ ██║   ██║██╔═══╝ ██║   ██║██║     ██╔══██║   ██║   ██╔══╝
//  ██║     ╚██████╔╝██║     ╚██████╔╝███████╗██║  ██║   ██║   ███████╗
//  ╚═╝      ╚═════╝ ╚═╝      ╚═════╝ ╚══════╝╚═╝  ╚═╝   ╚═╝   ╚══════╝
//
//  ██████╗ ██████╗  ██████╗      ██╗███████╗ ██████╗████████╗███████╗
//  ██╔══██╗██╔══██╗██╔═══██╗     ██║██╔════╝██╔════╝╚══██╔══╝██╔════╝
//  ██████╔╝██████╔╝██║   ██║     ██║█████╗  ██║        ██║   ███████╗
//  ██╔═══╝ ██╔══██╗██║   ██║██   ██║██╔══╝  ██║        ██║   ╚════██║
//  ██║     ██║  ██║╚██████╔╝╚█████╔╝███████╗╚██████╗   ██║   ███████║
//  ╚═╝     ╚═╝  ╚═╝ ╚═════╝  ╚════╝ ╚══════╝ ╚═════╝   ╚═╝   ╚══════╝
//
-----------------------------------------------------------------
```

#### Sub-headings

```bash
∑ kit exclaim 'SEND EMAIL via mailgun' --width=25 --font='Calvin S'
-----------------------------------------------------------------
OK, I copied an ASCII-art-ified version of that message to your clipboard:

//  ╔═╗╔═╗╔╗╔╔╦╗  ╔═╗╔╦╗╔═╗╦╦    ┬  ┬┬┌─┐  ┌┬┐┌─┐┬┬  ┌─┐┬ ┬┌┐┌
//  ╚═╗║╣ ║║║ ║║  ║╣ ║║║╠═╣║║    └┐┌┘│├─┤  │││├─┤││  │ ┬│ ││││
//  ╚═╝╚═╝╝╚╝═╩╝  ╚═╝╩ ╩╩ ╩╩╩═╝   └┘ ┴┴ ┴  ┴ ┴┴ ┴┴┴─┘└─┘└─┘┘└┘
-----------------------------------------------------------------
```



## kit h1

```bash
∑ kit h1 hi
-----------------------------------------------------------------
OK, I copied an ASCII-art-ified version of that message to your clipboard:

//  ██╗  ██╗██╗
//  ██║  ██║██║
//  ███████║██║
//  ██╔══██║██║
//  ██║  ██║██║
//  ╚═╝  ╚═╝╚═╝
//
-----------------------------------------------------------------
```


## kit h2

```bash

∑ kit h2 hi
-----------------------------------------------------------------
OK, I copied an ASCII-art-ified version of that message to your clipboard:

//  ┬ ┬┬
//  ├─┤│
//  ┴ ┴┴
-----------------------------------------------------------------
```



## Credits

This module wouldn\'t be possible without [@patorjk](https://github.com/patorjk)'s amazing work on [figlet](https://github.com/patorjk/figlet.js).

See also:
+ [h1](http://patorjk.com/software/taag/#p=display&c=c%2B%2B&f=ANSI%20Shadow&t=Use%20this%20font%20%0Ato%20delineate%0Amajor%20sections%0Aof%20your%20code%0A(no%20more%20than%0A%20once%20per%20every%0A%20200%20lines%20of%20code))
+ [h2](http://patorjk.com/software/taag/#p=display&c=c%2B%2B&f=Calvin%20S&t=use%20this%20font%20to%20indicate%0Asmaller%20sections%20of%20our%20code.%0A%0Ae.g.%0A%0ACLICK%0A%5B-build%20light%20in%20ribbon-%5D)



## Links / Reminders

+ [Make "Paste + Indent" the default behavior in Sublime Text 2](https://gist.github.com/mikermcneil/569874aad9a7c71a26ac8364c09f3a15)


## License

MIT