# @garment/plugin-runner-bin

> Executes system or node binary file with given args.

Latest version **0.18.0** (published 2022-03-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @garment/plugin-runner-bin
pnpm add @garment/plugin-runner-bin
yarn add @garment/plugin-runner-bin
bun add @garment/plugin-runner-bin
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.18.0 |
| Published | 2022-03-02 |
| First published | 2020-07-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 10.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | beshanoe, farfetch-oss |

## Links

- npm: https://www.npmjs.com/package/@garment/plugin-runner-bin
- npm.io page: https://npm.io/package/@garment/plugin-runner-bin

## Dependencies (3)

- [execa](https://npm.io/package/execa.md) ^1.0.0
- [npm-which](https://npm.io/package/npm-which.md) ^3.0.1
- [param-case](https://npm.io/package/param-case.md) ^2.1.1

## Recent versions

- 0.18.0 (latest) — 2022-03-02
- 0.16.0 — 2021-07-08
- 0.15.4 — 2021-03-22
- 0.15.2 — 2021-03-22
- 0.15.0 — 2021-03-19
- 0.14.0 — 2020-12-15
- 0.13.13 — 2020-09-29
- 0.13.10 — 2020-09-01
- 0.13.8 — 2020-07-15
- 0.13.7 — 2020-07-08

## README

# @garment/plugin-runner-bin

<!-- description src/index.ts firstInterface -->
Executes system or node binary file with given args.


## Installation

<!-- installation -->
`npm i @garment/plugin-runner-bin`

or

`yarn add @garment/plugin-runner-bin`

## Example usage

<!-- example src/index.ts firstInterface -->
```json
{
    "runner": "bin",
    "options": {
        "bin": "echo",
        "args": "garment is phenomenal"
    }
}
```

## API

<!-- api src/index.ts firstInterface  -->
`bin: string`

The name of the binary to execute. Garment will look up the path with the bin name you provided.

---

`args: string | string[] | { [key: string]: string | boolean | string[]; }`

The arguments to pass to the given `bin`.

---

`env: { [key: string]: string; }`

Environment variables

---

`stream: boolean`

Stream all the console output, otherwise it will be collected and output after the execution

---

`longRunning: boolean`

Not wait until the process is finished

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