71 lines
3.3 KiB
Markdown
71 lines
3.3 KiB
Markdown
# smartcli
|
|
|
|
nodejs wrapper for CLI related tasks
|
|
|
|
## Availabililty
|
|
|
|
[](https://www.npmjs.com/package/smartcli)
|
|
[](https://GitLab.com/pushrocks/smartcli)
|
|
[](https://github.com/pushrocks/smartcli)
|
|
[](https://pushrocks.gitlab.io/smartcli/)
|
|
|
|
## Status for master
|
|
|
|
[](https://GitLab.com/pushrocks/smartcli/commits/master)
|
|
[](https://GitLab.com/pushrocks/smartcli/commits/master)
|
|
[](https://www.npmjs.com/package/smartcli)
|
|
[](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/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
|
|
this plugin tries to establish some logic in which CLI tools work.
|
|
|
|
take the following commandline input:
|
|
|
|
```
|
|
mytool command argument1 argument2 --option1 -o2 option2Value
|
|
```
|
|
|
|
- `mytool` obviously is the tool (like git)
|
|
- `command` 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)
|
|
|
|
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.
|
|
|
|
```javascript
|
|
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"
|
|
});
|
|
|
|
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.
|
|
```
|
|
|
|
For further information read the linked docs at the top of this README.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
[](https://push.rocks)
|