Compare commits
4 Commits
Author | SHA1 | Date | |
---|---|---|---|
b1565dec3e | |||
f6969ecfd5 | |||
9bb85ca666 | |||
9442f738d9 |
31
README.md
31
README.md
@ -1,16 +1,31 @@
|
|||||||
# smartcli
|
# smartcli
|
||||||
nodejs wrapper for CLI related tasks
|
nodejs wrapper for CLI related tasks
|
||||||
|
[](https://github.com/pushrocks/smartcli/commits/dev)
|
||||||
|
|
||||||
### Buildstatus/Dependencies
|
### Buildstatus/Dependencies
|
||||||
[](https://travis-ci.org/pushrocks/smartcli)
|
[](https://travis-ci.org/pushrocks/smartcli)
|
||||||
[](https://david-dm.org/pushrocks/smartcli#info=devDependencies)
|
[](https://david-dm.org/pushrocks/smartcli#info=devDependencies)
|
||||||
|
|
||||||
### Usage
|
### Install the package
|
||||||
This npm package comes with everything you need to start your own gulp plugin.
|
npm install smartcli
|
||||||
|
|
||||||
We recommend modifying the ts/index.ts file,
|
### Usage
|
||||||
then run `npm install` to install the dev dependencies
|
```js
|
||||||
and use `npm test` to compile the TypeScript file.
|
var smartcli = require("smartcli");
|
||||||
|
|
||||||
Cheers
|
//returns true for terminal command "node myjs.js jazz"
|
||||||
|
smartcli.checkCommand('jazz');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* returns an object for terminal command "node myjs.js --myoption something like so
|
||||||
|
* {
|
||||||
|
* name: 'myoption',
|
||||||
|
* specified: true,
|
||||||
|
* value: 'something'
|
||||||
|
* }
|
||||||
|
*/
|
||||||
|
smartcli.getOption('myoption');
|
||||||
|
``
|
||||||
|
|
||||||
|
Cheers
|
||||||
Phil from Lossless Digital
|
Phil from Lossless Digital
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "smartcli",
|
"name": "smartcli",
|
||||||
"version": "0.0.8",
|
"version": "0.0.9",
|
||||||
"description": "nodejs wrapper for CLI related tasks",
|
"description": "nodejs wrapper for CLI related tasks",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
Reference in New Issue
Block a user