Client and server for remote CLI session such as xterm.js
Automatic Node.js version enforcement
Installation
npm install cli-kit --save
Usage
import CLI from 'cli-kit';(async () => { const { argv, _ } = await new CLI({ options: { '-f, --force': 'use the force', '--timeout [value]': { desc: 'the timeout duration', type: 'int' } } }).exec(); console.log('options:', argv); console.log('args:', _);})();
Architecture
In cli-kit, commands and options are grouped into "contexts". The main CLI instance defines the
"global context". Each command defines a new context. Each context can have its own commands,
options, and arguments. What you end up with is a hierarchy of contexts.
When cli-kit parses the command line arguments, it will check each argument against the global
context to see if the argument can be identified as a known command, option, or argument. If it
finds a command, it adds the command's context to a stack and re-parses any unidentified arguments.
This allows you to create deep and dynamic hierarchies of commands, options, and arguments.
Pseudo-Terminal Support
cli-kit extensions can be native binary executables or other Node.js scripts. When the extension is
a native executable, then it is executed using Node's spawn(). Note that spawned child processes
do not have a TTY and thus things like prompting will not work.
API
class CLI
A CLI intance defines a global context for which you add commands, options, and arguments.
const cli = new CLI({ // An array of argument definitions. They are parsed in the order they are defined. args: [ // An argument can be as simple as its name. Wrapping the name with `<` and `>` signifies // that the argument is required. '<arg1>', // To define an optional arguemnt, you can use `[` and `]`. '[arg2]', // Or simply omit the brackets 'arg3', // For more options, you can specify an argument descriptor { // The argument name. Follows the same rules as above. name: 'arg4', // The argument's description to show in the help output. desc: undefined, // When `true`, hides the argument from usage string in the help output. hidden: false, // When `true`, captures all subsequent argument values into an array multiple: false,
exec(args)
Parses the command line args and executes a command, if found.
args : Array<String> (optional)
An array of arguments. Each argument is expected to be a string.
Defaults to process.argv.slice(2).
Returns a Promise that resolves an Arguments object. This object will contain the parsed options
in argv and arguments in _.