| 1 | zaccaria-cli
|
| 2 | ============
|
| 3 |
|
| 4 | > {{description}}
|
| 5 |
|
| 6 | Install
|
| 7 | -------
|
| 8 |
|
| 9 | Install it with
|
| 10 |
|
| 11 | npm install zaccaria-cli
|
| 12 |
|
| 13 | Usage
|
| 14 | -----
|
| 15 |
|
| 16 | The following endpoints are exported:
|
| 17 |
|
| 18 | - `$s`: promisified shelljs
|
| 19 |
|
| 20 | - `$b, Promise`: bluebird promises
|
| 21 |
|
| 22 | - `$d`: docopt
|
| 23 |
|
| 24 | - `$f.readLocal`: read local assets (relative path).
|
| 25 |
|
| 26 | - `$r.stdin`: promisified read from stdin
|
| 27 |
|
| 28 | - `withTmp(f)`: executes `f` by passing it a temporary file (that is
|
| 29 | deleted once finished) - returns a promise.
|
| 30 |
|
| 31 | - `withTmpDir(f, opts)`: executes `f` by passing it a
|
| 32 | temporary directory. Returns a promise. See
|
| 33 | [here](https://github.com/raszi/node-tmp#options) for options (use
|
| 34 | `unsafeCleanup: true` to cleanup the directory).
|
| 35 |
|
| 36 | - `$yaml(text)`: parse a yaml file into an object
|
| 37 |
|
| 38 | - `$t$`: moment library
|
| 39 |
|
| 40 | Author
|
| 41 | ------
|
| 42 |
|
| 43 | - Vittorio Zaccaria
|
| 44 |
|
| 45 | License
|
| 46 | -------
|
| 47 |
|
| 48 | Released under the BSD License.
|
| 49 |
|
| 50 | ------------------------------------------------------------------------
|