@vimlet/cli

1.2.8 • Public • Published

Vimlet Cli

Command line interface for node.js. The easiest way to handle your application from console.

Installation

npm install @vimlet/cli

How to use

var cli = require("@vimlet/cli").instantiate();

vimlet-cli accepts flags and values:

  • flag: Commands which don't have value, like a boolean option. flag("shorcut", "flagName", "description")
  • value: Commands that will have a value. value("shorcut", "valueName", "description")

value(shortcut, name, description, handler)

flag(shortcut, name, description)

  • shortcut: they are not mandatory, they can be null o rempty.
  • name: value or flag name.
  • description: String to be shown on help.
  • handler: a function to be applied to the data inserted by the user.

IE:

cli
.flag("w", "windows", "This flag will set the platform as windows")
.value("e", "extension", "This value will tell the extension of the output file")
.flag("h", "--help", "Shows help")
.parse(arg);
  • parse() must be called at the end to parse the arguments.
  • arg arguments is a string that can be taken from console or wherever the user wants.

As an example call: example w e exe => This will set the platform as windows and the extension to exe.

Value also accept a handler as last param

value("t", "--test", "test handler", function(value){return value.split(",");})

In the example above, test data will be splitted by comas.

  • cli.printHelp(); Is a default function to print help in the console like:
Shortcut Name Description
h help Print help

License

Vimlet Cli is released under MIT License. See LICENSE for details.

Readme

Keywords

none

Package Sidebar

Install

npm i @vimlet/cli

Weekly Downloads

25

Version

1.2.8

License

MIT

Unpacked Size

13.5 MB

Total Files

293

Last publish

Collaborators

  • devsvimlet
  • lethevimlet