# askconfig

> Node.js module to ask for configuration via interactive shell

Latest version **4.0.4** (published 2019-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install askconfig
pnpm add askconfig
yarn add askconfig
bun add askconfig
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.4 |
| Published | 2019-07-05 |
| First published | 2015-09-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 3 |
| Unpacked size | 11.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |

## Links

- npm: https://www.npmjs.com/package/askconfig
- Repository: https://github.com/okunishinishi/node-askconfig
- Homepage: https://github.com/okunishinishi/node-askconfig#readme
- Issues: https://github.com/okunishinishi/node-askconfig/issues
- npm.io page: https://npm.io/package/askconfig

## Dependencies (3)

- [argx](https://npm.io/package/argx.md) ^4.0.2
- [objnest](https://npm.io/package/objnest.md) ^5.0.6
- [cli-color](https://npm.io/package/cli-color.md) ^1.4.0

## Recent versions

- 4.0.4 (latest) — 2019-07-05
- 4.0.2 — 2018-08-12
- 4.0.1 — 2018-02-26
- 4.0.0 — 2017-09-17
- 3.0.5 — 2016-07-30
- 3.0.4 — 2016-07-25
- 3.0.3 — 2016-07-25
- 3.0.2 — 2016-06-26
- 3.0.1 — 2016-06-17
- 3.0.0 — 2016-05-08
- 2.0.1 — 2016-01-23
- 2.0.0 — 2015-12-23
- 1.0.1 — 2015-09-12
- 1.0.0 — 2015-09-12

## README

askconfig
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![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

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Node.js module to ask for configuration via interactive shell

<!-- Description End -->




<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

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

<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

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)
  }
})


````


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

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

<!-- LICENSE End -->

---
_Source: https://npm.io/package/askconfig · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._