A library for easily creating observable CLI tasks with support for commands, arguments, and options.
Go to file
2022-08-07 11:40:45 +02:00
.vscode fix(core): update 2022-08-03 17:07:11 +02:00
docs fix(core): now works better with tapbundle tests 2020-04-13 21:44:27 +00:00
test fix(core): update 2022-08-03 18:47:35 +02:00
ts fix(core): update 2022-08-07 11:40:45 +02:00
.gitignore fix(core): now works better with tapbundle tests 2020-04-13 21:44:27 +00:00
.gitlab-ci.yml fix(core): update 2022-08-03 17:07:11 +02:00
LICENSE Initial commit 2015-10-04 23:06:36 +02:00
npmextra.json BREAKING CHANGE(core): switch to esm 2022-08-03 17:00:36 +02:00
package-lock.json 4.0.5 2022-08-04 12:22:49 +02:00
package.json 4.0.5 2022-08-04 12:22:49 +02:00
readme.md fix(core): update 2021-04-07 20:25:17 +00:00
tsconfig.json BREAKING CHANGE(core): switch to esm 2022-08-03 17:00:36 +02:00

@pushrocks/smartcli

easy observable cli tasks

Status for master

Status Category Status Badge
GitLab Pipelines pipeline status
GitLab Pipline Test Coverage coverage report
npm npm downloads per month
Snyk Known Vulnerabilities
TypeScript Support TypeScript
node Support node
Code Style Code Style
PackagePhobia (total standalone install weight) PackagePhobia
PackagePhobia (package size on registry) PackagePhobia
BundlePhobia (total size when bundled) BundlePhobia
Platform support Supports Windows 10 Supports Mac OS X

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.

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.

Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can contribute one time or contribute monthly. :)

For further information read the linked docs at the top of this readme.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer