50 lines
2.2 KiB
Markdown
50 lines
2.2 KiB
Markdown
# smartcli
|
|
nodejs wrapper for CLI related tasks. TypeScript ready.
|
|
|
|
## 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)
|
|
[](https://david-dm.org/pushrocks/smartcli)
|
|
[](https://www.bithound.io/github/pushrocks/smartcli/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/pushrocks/smartcli)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
## Install the package
|
|
npm install smartcli --save
|
|
|
|
## Usage
|
|
|
|
this plugin tries to establish some logic in which CLI tools work.
|
|
|
|
take the following commandline input:
|
|
|
|
```
|
|
mytool function argument1 argument2 --option1 -o2 option2Value
|
|
```
|
|
|
|
* 'mytool' obviously is the tool (like git)
|
|
* function is the main thing the tool shall do (like commit)
|
|
* argument1 and argument2 are arguments
|
|
* option1 is a longform option you can add (like --message for message)
|
|
* optionValue is the referenced option value (like a commit message)
|
|
|
|
```typescript
|
|
import {Smartcli} from "smartcli"
|
|
mySmartcli = new Smartcli();
|
|
mySmartcli.standardTask()
|
|
.then(argvArg => {
|
|
// do something if program is called without an command
|
|
});
|
|
|
|
mySmartcli.addCommand({commandname: 'install'})
|
|
.then(argvArg => {
|
|
// do something if program is called with command "install"
|
|
})
|
|
``` |