# pon-task-command

> Pon task to execute commands

Latest version **3.1.8** (published 2020-11-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install pon-task-command
pnpm add pon-task-command
yarn add pon-task-command
bun add pon-task-command
```

## 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 | 3.1.8 |
| Published | 2020-11-17 |
| First published | 2017-04-26 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 2 |
| Unpacked size | 47.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Taka Okunishi |
| Maintainers | realglobe |
| Keywords | Pon |

## Links

- npm: https://www.npmjs.com/package/pon-task-command
- Repository: https://github.com/realglobe-Inc/pon-task-command
- Homepage: https://github.com/realglobe-Inc/pon-task-command#readme
- Issues: https://github.com/realglobe-Inc/pon-task-command/issues
- npm.io page: https://npm.io/package/pon-task-command

## Dependencies (2)

- [argx](https://npm.io/package/argx.md) ^4.0.4
- [hasbin](https://npm.io/package/hasbin.md) ^1.2.3

## Recent versions

- 3.1.8 (latest) — 2020-11-17
- 3.1.7 — 2020-11-17
- 3.1.6 — 2019-04-02
- 3.1.5 — 2019-03-20
- 3.1.4 — 2019-02-28
- 3.1.3 — 2018-11-16
- 3.1.2 — 2018-11-16
- 3.1.1 — 2018-03-24
- 3.0.1 — 2018-01-17
- 2.0.4 — 2018-01-15
- 2.0.3 — 2018-01-13
- 2.0.2 — 2017-12-31
- 2.0.1 — 2017-10-21
- 1.0.5 — 2017-05-26
- 1.0.4 — 2017-05-17
- … 2 more at https://npm.io/package/pon-task-command/versions

## README

pon-task-command
==========

<!---
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]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/realglobe-Inc/pon-task-command
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/pon-task-command
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/pon-task-command.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/pon-task-command
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/pon-task-command.svg?token=
[bd_license_url]: https://github.com/realglobe-Inc/pon-task-command/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/pon-task-command
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/pon-task-command.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/pon-task-command.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/pon-task-command
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/pon-task-command.svg
[bd_npm_url]: http://www.npmjs.org/package/pon-task-command
[bd_npm_shield_url]: http://img.shields.io/npm/v/pon-task-command.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>

Pon task to execute commands

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview 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 pon-task-command --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
'use strict'

const pon = require('pon')
const { fork } = require('pon-task-command')

async function tryExample () {
  let run = pon({
    'dev': fork('./bin/app.js', {
      env: { DEBUG: 'project:*' }
    })
  })

  run('dev')
}

tryExample()

```


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

<!-- Section from "doc/guides/03.Signature.md.hbs" Start -->

<a name="section-doc-guides-03-signature-md"></a>

Signatures
---------


### `define(cmd, args, options) -> function`

Define task

| Param | type | Description |
| ---- | --- | ----------- |
| cmd | string |  Command to execute |
| args | string[] |  Command arguments |
| options | Object |  Optional settings |


### `fork(cmd, args, options) -> function`

Forking task

| Param | type | Description |
| ---- | --- | ----------- |
| cmd | string |  Command to execute |
| args | string[] |  Command arguments |
| options | Object |  Optional settings |
| options.messageHandler | function |  Message handler |


### `spawn(cmd, args, options) -> function`

Spawning task

| Param | type | Description |
| ---- | --- | ----------- |
| cmd | string |  Command to execute |
| args | string[] |  Command arguments |
| options | Object |  Optional settings |



<!-- Section from "doc/guides/03.Signature.md.hbs" End -->


<!-- Sections Start -->


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

License
-------
This software is released under the [Apache-2.0 License](https://github.com/realglobe-Inc/pon-task-command/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [Pon][pon_url]
+ [Realglobe, Inc.][realglobe,_inc__url]

[pon_url]: https://github.com/realglobe-Inc/pon
[realglobe,_inc__url]: http://realglobe.jp

<!-- Links End -->

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