2015-10-04 21:21:10 +00:00
|
|
|
# smartcli
|
2016-05-12 01:27:45 +00:00
|
|
|
nodejs wrapper for CLI related tasks. TypeScript ready.
|
2015-10-04 21:21:10 +00:00
|
|
|
|
2016-09-04 15:32:12 +00:00
|
|
|
## Availabililty
|
|
|
|
|
[](https://www.npmjs.com/package/smartcli)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartcli)
|
|
|
|
|
[](https://github.com/pushrocks/smartcli)
|
|
|
|
|
[](https://pushrocks.gitlab.io/smartcli/docs)
|
|
|
|
|
|
|
|
|
|
## Status for master
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartcli/commits/master)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartcli/commits/master)
|
2016-04-04 23:22:11 +00:00
|
|
|
[](https://david-dm.org/pushrocks/smartcli)
|
2016-09-04 15:32:12 +00:00
|
|
|
[](https://www.bithound.io/github/pushrocks/smartcli/master/dependencies/npm)
|
2016-04-04 23:22:11 +00:00
|
|
|
[](https://www.bithound.io/github/pushrocks/smartcli)
|
2016-09-04 15:32:12 +00:00
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
2015-10-04 21:21:10 +00:00
|
|
|
|
2015-11-09 03:02:46 +00:00
|
|
|
## Install the package
|
2016-04-04 23:22:11 +00:00
|
|
|
npm install smartcli --save
|
2015-10-14 19:14:20 +00:00
|
|
|
|
2015-11-09 03:02:46 +00:00
|
|
|
## Usage
|
2015-11-05 20:43:34 +00:00
|
|
|
|
|
|
|
|
this plugin tries to establish some logic in which CLI tools work.
|
|
|
|
|
|
|
|
|
|
take the following commandline input:
|
|
|
|
|
|
|
|
|
|
```
|
2016-11-19 16:48:07 +00:00
|
|
|
mytool command argument1 argument2 --option1 -o2 option2Value
|
2015-11-05 20:43:34 +00:00
|
|
|
```
|
|
|
|
|
|
2016-11-19 16:48:07 +00:00
|
|
|
* `mytool` obviously is the tool (like git)
|
|
|
|
|
* `command` is the main thing the tool shall do (like commit)
|
2016-11-19 16:48:56 +00:00
|
|
|
* `argument1` and `argument2` are arguments
|
2016-11-19 16:48:07 +00:00
|
|
|
* `option1` is a longform option you can add (like --message for message)
|
|
|
|
|
* `optionValue` is the referenced option value (like a commit message)
|
|
|
|
|
|
|
|
|
|
When there is no command and no option specified the standardTask applied.
|
|
|
|
|
When there is a option specified but no command, standardTask applies,
|
|
|
|
|
except when of the options is -v, --version or --help.
|
2015-11-05 20:43:34 +00:00
|
|
|
|
2016-11-19 14:02:24 +00:00
|
|
|
```javascript
|
2016-08-26 09:52:09 +00:00
|
|
|
import {Smartcli} from "smartcli"
|
|
|
|
|
mySmartcli = new Smartcli();
|
|
|
|
|
mySmartcli.standardTask()
|
|
|
|
|
.then(argvArg => {
|
|
|
|
|
// do something if program is called without an command
|
|
|
|
|
});
|
|
|
|
|
|
2016-10-14 22:56:02 +00:00
|
|
|
mySmartcli.addCommand({commandname: 'install'})
|
|
|
|
|
.then(argvArg => {
|
|
|
|
|
// do something if program is called with command "install"
|
|
|
|
|
})
|
2016-11-19 14:02:24 +00:00
|
|
|
|
|
|
|
|
mySmartcli.addVersion('1.0.0') // -v and --version options will display the specified version in the terminal
|
|
|
|
|
|
|
|
|
|
mySmartCli.addHelp({ // is triggered by help command and --help option
|
|
|
|
|
helpText: 'some help text to print' // the helpText to display
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
mySmartcli.startParse() // starts the evaluation and fullfills or rejects promises.
|
2016-10-15 00:12:10 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
[](https://push.rocks)
|
