conventional-cli v1.2.0

conventional-cli

Simple Conventional for Command Line Interface (CLI)

Table of Contents

• Background
• Installation
• Usage
• Contribute
• License

Background

There are a lot of CLI. This repository contains a proposal to check create interfaces and models for conventional of all CLI tools.

Installation

NPM

npm install conventional-cli

Usage

import { Argument, IArgument, ArgumentTypes } from 'conventional-cli';

const argument: IArgument = new Argument();
argument.longName = '--argument';
argument.shortName = '-A';
argument.description = 'Full description of argument';
argument.additionalDescription = 'Additional description of argument';
argument.type = ArgumentTypes.enum;
argument.values = ['enum1', 'enum2', 'enum3', 'enum4'];
argument.default = 'enum2';
argument.required = false;
argument.deprecated = false;
argument.delimiter = ' ';
argument.beta = '';

Contribute

You may contribute in several ways like requesting new features, adding tests, fixing bugs, improving documentation or examples. Please check our contributing guidelines.

License

MIT