smartcli/README.md

32 lines
896 B
Markdown
Raw Normal View History

2015-10-04 21:21:10 +00:00
# smartcli
2015-10-14 19:01:39 +00:00
nodejs wrapper for CLI related tasks
[![Dev Status](https://img.shields.io/badge/DevStatus-Active-green.svg)](https://github.com/pushrocks/smartcli/commits/dev)
2015-10-04 21:21:10 +00:00
### Buildstatus/Dependencies
[![Build Status](https://travis-ci.org/pushrocks/smartcli.svg?branch=master)](https://travis-ci.org/pushrocks/smartcli)
[![devDependency Status](https://david-dm.org/pushrocks/smartcli/dev-status.svg)](https://david-dm.org/pushrocks/smartcli#info=devDependencies)
2015-10-14 19:14:20 +00:00
### Install the package
npm install smartcli
2015-10-04 21:21:10 +00:00
### Usage
2015-10-14 19:09:26 +00:00
```js
2015-10-14 19:14:20 +00:00
var smartcli = require("smartcli");
2015-10-04 21:21:10 +00:00
2015-10-14 19:14:20 +00:00
//returns true for terminal command "node myjs.js jazz"
2015-10-14 19:09:26 +00:00
smartcli.checkCommand('jazz');
2015-10-14 19:14:20 +00:00
/**
* returns an object for terminal command "node myjs.js --myoption something like so
* {
* name: 'myoption',
* specified: true,
* value: 'something'
* }
*/
2015-10-14 19:09:26 +00:00
smartcli.getOption('myoption');
``
Cheers
2015-10-04 21:21:10 +00:00
Phil from Lossless Digital