smartcli/README.md

50 lines
2.2 KiB
Markdown
Raw Normal View History

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
[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartcli)
[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartcli)
[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartcli)
[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartcli/docs)
## Status for master
[![build status](https://gitlab.com/pushrocks/smartcli/badges/master/build.svg)](https://gitlab.com/pushrocks/smartcli/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartcli/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartcli/commits/master)
2016-04-04 23:22:11 +00:00
[![Dependency Status](https://david-dm.org/pushrocks/smartcli.svg)](https://david-dm.org/pushrocks/smartcli)
2016-09-04 15:32:12 +00:00
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartcli/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartcli/master/dependencies/npm)
2016-04-04 23:22:11 +00:00
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartcli/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartcli)
2016-09-04 15:32:12 +00:00
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](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-08-26 09:52:09 +00:00
mytool function argument1 argument2 --option1 -o2 option2Value
2015-11-05 20:43:34 +00:00
```
* 'mytool' obviously is the tool (like git)
* function is the main thing the tool shall do (like commit)
2016-08-26 09:52:09 +00:00
* argument1 and argument2 are arguments
* option1 is a longform option you can add (like --message for message)
2015-11-05 20:43:34 +00:00
* optionValue is the referenced option value (like a commit message)
2016-05-12 01:27:45 +00:00
```typescript
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-08-26 09:52:09 +00:00
```