fix(core): update
This commit is contained in:
		@@ -23,44 +23,7 @@ nodejs wrapper for CLI related tasks
 | 
			
		||||
 | 
			
		||||
## 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.
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user