Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/okunishinishi/node-askconfig

Node.js module to ask for configuration via interactive shell
https://github.com/okunishinishi/node-askconfig

Last synced: 2 months ago
JSON representation

Node.js module to ask for configuration via interactive shell

Awesome Lists containing this project

README

        

askconfig
==========

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/okunishinishi/node-askconfig
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-askconfig
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-askconfig.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-askconfig
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-askconfig.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-askconfig/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-askconfig
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-askconfig.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-askconfig.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-askconfig
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-askconfig.svg
[bd_npm_url]: http://www.npmjs.org/package/askconfig
[bd_npm_shield_url]: http://img.shields.io/npm/v/askconfig.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

Node.js module to ask for configuration via interactive shell

Installation
-----

```bash
npm install askconfig --save
```

Usage
-----

```javascript
#!/usr/bin/env node
'use strict'

const askconfig = require('askconfig')

askconfig({
name: 'default-name',
description: ''
}).then((result) => {
if (err) {
console.error(err)
process.exit(1)
} else {
console.log(`Result: ${result}`)
process.exit(0)
}
})

````

License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-askconfig/blob/master/LICENSE).