smartcli

nodejs wrapper for CLI related tasks. TypeScript ready.

Status

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 option1Value --option2 option2Value

'mytool' obviously is the tool (like git)
function is the main thing the tool shall do (like commit)
option is an option you can add (like -m for message)
optionValue is the referenced option value (like a commit message)

The inner organization of smartcli

smartcli exposes three major groups of functions:

check functions
- are grouped in smartcli.checks object
get functions
- are grouped in smartcli.get object
async interaction functions
- are grouped in smartcli.interaction object

Methods

The examples are written in TypeScript

import * as smartcli from  "smartcli"

/* -------------- Check Functions -------------------*/
smartcli.check.command("jazz"); // check  for a special command.
smartcli.check.commandPresence() // check if any command is specified
smartcli.check.commandArguemnt("myargument",1) // checks if a special argument is given, second argument is level
smartcli.check.commandArguemntPresence // checks of any Argument is present
smartcli.check.option("someoption") // checks for a specific option
smartcli.check.optionPresence() // checks if any option is specified
smartcli.get.option('myoption'); //

2.0 KiB Raw Blame History