# prosh

> A promise shell.

Latest version **1.3.1** (published 2017-09-22) · MIT license · 0 weekly downloads

## Install

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

## 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.3.1 |
| Published | 2017-09-22 |
| First published | 2016-01-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | joshrtay, yaws |

## Links

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

## Dependencies (4)

- [co](https://npm.io/package/co.md) ^4.6.0
- [find-mod](https://npm.io/package/find-mod.md) ^1.0.0
- [@f/assign](https://npm.io/package/@f/assign.md) ^1.2.1
- [@f/extend](https://npm.io/package/@f/extend.md) ^1.0.0

## Recent versions

- 1.3.1 (latest) — 2017-09-22
- 1.3.0 — 2017-09-22
- 1.2.6 — 2017-09-22
- 1.2.4 — 2016-05-25
- 1.2.3 — 2016-05-17
- 1.2.2 — 2016-05-17
- 1.2.1 — 2016-05-17
- 1.2.0 — 2016-05-17
- 1.1.1 — 2016-05-17
- 1.1.0 — 2016-05-07
- 1.0.2 — 2016-01-29
- 1.0.1 — 2016-01-27
- 1.0.0 — 2016-01-27

## README

# prosh

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

A promise shell.

## Installation

    $ npm install prosh

## Usage

```js
import prosh from 'prosh'
import co from 'co'

co(function * () {
  yield prosh(`
    echo "hello world"
    echo "hello world"
    `)
})

```

## API

### prosh(command)

- `command` - command string the same way you would write it in a shell

**Returns:** a promise the resolves {code, output, time}, where `code` is exit code, `output` is stdout and stderr and `time` is run time

## License

MIT

[travis-image]: https://img.shields.io/travis/joshrtay/prosh.svg?style=flat-square
[travis-url]: https://travis-ci.org/joshrtay/prosh
[git-image]: https://img.shields.io/github/tag/joshrtay/prosh.svg
[git-url]: https://github.com/joshrtay/prosh
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/prosh.svg?style=flat-square
[npm-url]: https://npmjs.org/package/prosh

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