# celeri

> ![Alt command line](http://i.imgur.com/DA77U.png)

Latest version **1.0.0** (published 2015-08-31) · ISC license · 0 weekly downloads

## Install

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

## 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 | 1.0.0 |
| Published | 2015-08-31 |
| First published | 2011-09-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 164 |
| Maintainers | architectd |

## Links

- npm: https://www.npmjs.com/package/celeri
- Repository: https://github.com/crcn/celeri
- Homepage: https://github.com/crcn/celeri#readme
- Issues: https://github.com/crcn/celeri/issues
- npm.io page: https://npm.io/package/celeri

## Dependencies (1)

- [xtend](https://npm.io/package/xtend.md) ^4.0.0

## Recent versions

- 1.0.0 (latest) — 2015-08-31
- 0.3.4 — 2014-09-01
- 0.3.3 — 2013-08-06
- 0.3.2 — 2013-02-23
- 0.3.1 — 2013-01-28
- 0.3.0 — 2013-01-28
- 0.2.16 — 2012-08-23
- 0.2.15 — 2012-08-23
- 0.2.14 — 2012-02-28
- 0.2.13 — 2012-02-27
- 0.2.12 — 2012-02-17
- 0.2.11 — 2012-02-09
- 0.2.10 — 2012-02-08
- 0.2.9 — 2012-02-01
- 0.2.8 — 2012-02-01
- … 19 more at https://npm.io/package/celeri/versions

## README

C-e-L-er-I is an es6 command line utility belt library for [NodeJS](https://nodejs.org/).

#### Example

```javascript
{ prompt, confirm } = require("celeri");

var name = yield prompt("What is your name?"); 

console.log(name);

if (yield confirm("Do you like dog spaghetti?")) {
    console.log("awesome!");
}
```

#### Utilities

- [prompt](#prompt) - prompt the user for input
- [confirm](#confirm) - confirm yes/no
- [pickOne](#) - pick one item from the list

#### Promise celeri.prompt(label)

Prompts the user for a question

```javascript
import { prompt } from "celeri";
console.log("Your name is %s", yield prompt("What is your name?"));
```

#### Promise celeri.confirm(label, default)

Confirm y/n


```javascript
import { confirm } from "celeri";
if (yield confirm("Do you like cheese?", true)) {
    console.log("you like cheese.");
} else {
    console.log("you do not like cheese.");
}
```

#### Promise celeri.pickOne(label, items)

Picks one item from a list

```javascript
import { pickOne, listItem } from "celeri";

var color = yield pickOne("What is your favorite color?", ["red", "green", "blue"]);

console.log("your favorite color is %s", color);
```

#### Promise celeri.pickMany(label, items)

Picks many items from a list

```javascript
var colors = yield pickMany("what are your favorite colors?", ["red", "green", "blue"]);
```

#### Promise celeri.secret(label)

Prompts the user for a secret value (hidden from stdout).

```javascript
var password = yield secret("What's the secret?");
```

#### ListItem celeri.listItem(optionsOrValue)

Creates a new list item

- `optionsOrValue` - options or value of list item
    - `label` 

```javascript
var glob = require("glob");
var file = yield pickOne("Pick a file", glob.sync(process.cwd() + "/*").map(function(filename) {
    return listItem({
        label: filename,
        value: filename
    })
}))
```

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