# bash

> Utilities for using bash from node.js.

Latest version **0.0.1** (published 2011-08-22) · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2011-08-22 |
| First published | 2011-08-22 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 25 |
| Author | Felix Geisendörfer |
| Maintainers | felixge |

## Links

- npm: https://www.npmjs.com/package/bash
- Repository: https://github.com/felixge/node-bash
- npm.io page: https://npm.io/package/bash

## Recent versions

- 0.0.1 (latest) — 2011-08-22

## README

# bash

Utilities for using bash from node.js.

## API

### bash.escape(parameter)

Escapes the given `parameter` for bash. This is done by escaping all non
alpha-numeric / dash characters with a backslash.

Example:

```javascript
> bash.escape('hello world');
'Hello\\ World'
```

### bash.args(options, prefix, suffix)

Takes a list of `options` and turns them into an arguments string common to
most *nix programs.

Objects are turned into arguments:

```javascript
> bash.args({a: 1, b: 2}, '--', '=');
'--a=1 --b=2'
```

Values are escaped:

```javascript
> bash.args({foo: 'hi you'}, '--', '=');
'--foo=hi\\ you'
```

Array values turn into multiple arguments:

```javascript
> bash.args({a: [1, 2]}, '--', '=');
'--a=1 --a=2'
```

`null` / `true` values turn into flags:

```javascript
> bash.args({a: true, b: null}, '--', '=');
'--a --b'
```

Alternate suffix / prefix settings:

```javascript
> bash.args({a: 1, b: 2}, '-', ' ');
'-a 1 -b 2'
```

`options` can be an array as well:

```javascript
> bash.args([{a: 1}, {a: 2, b: 3}] '-', ' ');
'-a 1 -a 2 -b 3'
```

## License

This library is released under the MIT license.

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