https://github.com/s-a/n-cli

A bundle of tools to develop node commandline applications
https://github.com/s-a/n-cli

Last synced: about 5 hours ago
JSON representation

A bundle of tools to develop node commandline applications

• Host: GitHub
• URL: https://github.com/s-a/n-cli
• Owner: s-a
• License: mit
• Created: 2016-09-09T11:06:47.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T05:04:30.000Z (4 months ago)
• Last Synced: 2024-09-18T14:29:43.453Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 813 KB
• Stars: 11
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# n-cli [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status](https://coveralls.io/repos/github/s-a/n-cli/badge.svg?branch=master)](https://coveralls.io/github/s-a/n-cli?branch=master) [![Donate](http://s-a.github.io/donate/donate.svg)](http://s-a.github.io/donate/)

> a usefull toolset for node commandline applications

## Installation

```sh

$ npm install --save n-cli

```

## Usage

```js

#!/usr/bin/env node

"use strict";

var Cli = new require("n-cli");

var cli = new Cli({

  silent: false,

  handleUncaughtException : true, // beautifies error output to console

  handledRejectionPromiseError : true, // beautifyies error output to console

  runcom : ".myapprc"

});

cli.on("unicorn", function(){

    this.argv.notNull("rainbow");

    this.log(this);

});

cli.runcom(function(rc){ 

    this.log(rc);

});

```

```sh

$ your-client-app unicorn --rainbow forever;

# yields :

{

  prettyError:

   PrettyError { },

  init:

   { appname: 'node-cli-example-app-1',

     handleUncaughtException: true },

  argv: { _: [ 'unicorn' ], rainbow: 'e', notNull: [Function: bound ] },

  config:

   { settings: {},

     appFolder: 'c:\\git\\n-cli\\examples',

     appPackageFilename: 'c:\\git\\n-cli\\examples\\package.json',

     appPackage: {},

     appName: 'node-cli-example-app-1',

     dataFolder: 'C:\\Users\\User\\AppData\\Roaming\\node-cli-example-app-1',

     filename: 'C:\\Users\\User\\AppData\\Roaming\\node-cli-example-app-1\\config.json' },

  color:

   Chalk { },

  Error: [Function: NodeCliError],

  minimist: [Function]

}

```

```sh

$ your-client-app unicorn --rainbow ;

# yields : missing-parameter-value missing value for parameter rainbow.

```

## Build in functions

ncli adds automatically some methods to your commandline application.

```sh

# output your version number

$ your-client-app -v;

```

Output [COMMANDLINE-ARGUMENTS.md](COMMANDLINE-ARGUMENTS.md) in your projects root folder

```sh

$ your-client-app help;

```

[![Help Demo][help-demo-image]][help-demo-image]

## API

-   [API description](API.md)

## Demo

## License

MIT © [s-a](https://github.com/s-a)

[npm-image]: https://badge.fury.io/js/n-cli.svg

[npm-url]: https://npmjs.org/package/n-cli

[travis-image]: https://travis-ci.org/s-a/n-cli.svg?branch=master

[travis-url]: https://travis-ci.org/s-a/n-cli

[daviddm-image]: https://david-dm.org/s-a/n-cli.svg?theme=shields.io

[daviddm-url]: https://david-dm.org/s-a/n-cli

[coveralls-image]: https://coveralls.io/repos/s-a/n-cli/badge.svg

[coveralls-url]: https://coveralls.io/r/s-a/n-cli

[help-demo-image]: help-demo.png