Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Node.js module to execute CLI command on sub process.
https://github.com/okunishinishi/node-execcli

Last synced: 2 months ago
JSON representation

Node.js module to execute CLI command on sub process.

Awesome Lists containing this project

README

        

execcli
==========

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

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

Execute CLI command on sub process.

Installation
-----

```bash
npm install execcli --save
```

Usage
----

```javascript
#!/usr/bin/env node

/**
* This is an example to use execcli.
*/

'use strict'

const execcli = require('execcli')

// Equivalent to execute `ls -l .` from command line.
execcli('ls', [ '.', { 'l': true } ]).then(() => {
/* ... */
})

````

Options
-------

| Key | Description | Default |
| --- | --- | --- |
| notfound | Instruction text when bin not found. | '' |
| cwd | Working directory path | process.cwd() |

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