# bin-wrapper

> Binary wrapper that makes your programs seamlessly available as local dependencies

Latest version **4.1.0** (published 2018-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install bin-wrapper
pnpm add bin-wrapper
yarn add bin-wrapper
bun add bin-wrapper
```

## 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 | 4.1.0 |
| Published | 2018-11-07 |
| First published | 2013-09-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 6 |
| Unpacked size | 7.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 154 |
| Author | Kevin Mårtensson |
| Maintainers | kevva, shinnn, sindresorhus |
| Keywords | bin, check, local, wrapper |

## Links

- npm: https://www.npmjs.com/package/bin-wrapper
- Repository: https://github.com/kevva/bin-wrapper
- Homepage: https://github.com/kevva/bin-wrapper#readme
- Issues: https://github.com/kevva/bin-wrapper/issues
- npm.io page: https://npm.io/package/bin-wrapper

## Dependencies (6)

- [pify](https://npm.io/package/pify.md) ^4.0.1
- [download](https://npm.io/package/download.md) ^7.1.0
- [bin-check](https://npm.io/package/bin-check.md) ^4.1.0
- [import-lazy](https://npm.io/package/import-lazy.md) ^3.1.0
- [os-filter-obj](https://npm.io/package/os-filter-obj.md) ^2.0.0
- [bin-version-check](https://npm.io/package/bin-version-check.md) ^4.0.0

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads

## Recent versions

- 4.1.0 (latest) — 2018-11-07
- 4.0.1 — 2018-10-30
- 4.0.0 — 2018-07-16
- 3.0.2 — 2015-06-16
- 3.0.1 — 2015-04-26
- 3.0.0 — 2015-02-10
- 2.1.3 — 2014-12-29
- 2.1.2 — 2014-12-28
- 2.1.1 — 2014-11-26
- 2.1.0 — 2014-11-05
- 2.0.2 — 2014-10-25
- 2.0.1 — 2014-10-20
- 2.0.0 — 2014-10-19
- 1.0.5 — 2014-09-30
- 1.0.4 — 2014-09-24
- … 24 more at https://npm.io/package/bin-wrapper/versions

## README

# bin-wrapper [![Build Status](https://travis-ci.org/kevva/bin-wrapper.svg?branch=master)](https://travis-ci.org/kevva/bin-wrapper)

> Binary wrapper that makes your programs seamlessly available as local dependencies


## Install

```
$ npm install bin-wrapper
```


## Usage

```js
const BinWrapper = require('bin-wrapper');

const base = 'https://github.com/imagemin/gifsicle-bin/raw/master/vendor';
const bin = new BinWrapper()
	.src(`${base}/macos/gifsicle`, 'darwin')
	.src(`${base}/linux/x64/gifsicle`, 'linux', 'x64')
	.src(`${base}/win/x64/gifsicle.exe`, 'win32', 'x64')
	.dest(path.join('vendor'))
	.use(process.platform === 'win32' ? 'gifsicle.exe' : 'gifsicle')
	.version('>=1.71');

(async () => {
	await bin.run(['--version']);
	console.log('gifsicle is working');
})();
```

Get the path to your binary with `bin.path()`:

```js
console.log(bin.path());
//=> 'path/to/vendor/gifsicle'
```


## API

### `new BinWrapper(options)`

Creates a new `BinWrapper` instance.

#### options

Type: `Object`

##### skipCheck

Type: `boolean`<br>
Default: `false`

Whether to skip the binary check or not.

##### strip

Type: `number`<br>
Default: `1`

Strip a number of leading paths from file names on extraction.

### .src(url, [os], [arch])

Adds a source to download.

#### url

Type: `string`

Accepts a URL pointing to a file to download.

#### os

Type: `string`

Tie the source to a specific OS.

#### arch

Type: `string`

Tie the source to a specific arch.

### .dest(destination)

#### destination

Type: `string`

Accepts a path which the files will be downloaded to.

### .use(binary)

#### binary

Type: `string`

Define which file to use as the binary.

### .path()

Returns the full path to your binary.

### .version(range)

#### range

Type: `string`

Define a [semver range](https://github.com/isaacs/node-semver#ranges) to check
the binary against.

### .run([arguments])

Runs the search for the binary. If no binary is found it will download the file
using the URL provided in `.src()`.

#### arguments

Type: `Array`<br>
Default: `['--version']`

Command to run the binary with. If it exits with code `0` it means that the
binary is working.


## License

MIT © [Kevin Mårtensson](http://kevinmartensson.com)

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