@clinjs/clargs v1.0.2

Clargs

Clargs is a simple light parser for building cli with node.js.

Installation

using npm npm i @clinjs/clargs

using yarn yarn add @clinjs/clargs

Setup

use clargs.setup() to configure your cli.

clargs.setup({
  usage: 'commity <command> <options>',
  options: [
    {
      name: '--push',
      alias: '-p',
      description: 'push changes to current remote branch after commiting',
    },
    {
      name: '--addAll',
      alias: '-a',
      description: 'add all staged changes before commiting',
    },
  ],
  commands: [
    {
      name: 'init',
      description: 'inititialize Commity',
      options: [
        {
          name: '--overwrite',
          alias: '-o',
          description: 'overwrite existing config (if exist)',
        },
      ],
    },
  ],
});

Parse

Once you have setup clargs, you have to use clargs.parse() before accessing commands and options.

Commands

:pushpin: You have to use clargs.parse() Parse before clargs.hasCommand(command: string)

const clargs = require('@clinjs/clargs');

clargs.setup({
  // ...
});
clargs.parse();
if (clargs.commandUsed('init')) {
  console.log('Command "init" used');
};

Help

Clargs includes help command that output cli usage, commands and options.

Options

:pushpin: You have to use clargs.parse() Parse before clargs.hasOption(option: string, alias: string)

const clargs = require('@clinjs/clargs');

clargs.setup({
  // ...
});
clargs.parse();
if (clargs.hasOption('--foo', '-f',)) {
  console.log('--foo option passed');
}