# install-packages

> Install dependencies using Yarn with npm fallback.

Latest version **0.2.5** (published 2018-09-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install install-packages
pnpm add install-packages
yarn add install-packages
bun add install-packages
```

## 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.2.5 |
| Published | 2018-09-08 |
| First published | 2018-04-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 6 |
| Unpacked size | 13.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 18 |
| Author | EGOIST |
| Maintainers | egoist |
| Keywords | yarn, install |

## Links

- npm: https://www.npmjs.com/package/install-packages
- Repository: https://github.com/egoist/install-packages
- Homepage: https://github.com/egoist/install-packages#readme
- Issues: https://github.com/egoist/install-packages/issues
- npm.io page: https://npm.io/package/install-packages

## Dependencies (6)

- [chalk](https://npm.io/package/chalk.md) ^2.3.2
- [joycon](https://npm.io/package/joycon.md) ^2.1.1
- [resolve](https://npm.io/package/resolve.md) ^1.7.1
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^4.0.2
- [command-exists](https://npm.io/package/command-exists.md) ^1.2.6
- [parse-package-name](https://npm.io/package/parse-package-name.md) ^0.1.0

## Recent versions

- 0.2.5 (latest) — 2018-09-08
- 0.2.4 — 2018-09-08
- 0.2.3 — 2018-04-23
- 0.2.2 — 2018-04-22
- 0.2.1 — 2018-04-22
- 0.2.0 — 2018-04-22
- 0.1.1 — 2018-04-16
- 0.1.0 — 2018-04-15

## README

# install-packages [![NPM version](https://img.shields.io/npm/v/install-packages.svg?style=flat-square)](https://npmjs.com/package/install-packages) [![NPM downloads](https://img.shields.io/npm/dm/install-packages.svg?style=flat-square)](https://npmjs.com/package/install-packages) [![Build Status](https://img.shields.io/circleci/project/egoist/install-packages/master.svg?style=flat-square)](https://circleci.com/gh/egoist/install-packages)

Programmatically install npm packages.

This is used by [webpack-proxy](https://github.com/egoist/webpack-proxy), here's a preview:

<img src="https://cdn.rawgit.com/egoist/76286067838fbd60db786b5a75df386c/raw/63a63a8f0a732f17e38427e33daa8ab79beec7d6/webpack-proxy.svg" alt="preview" width="500">

## Install

```bash
yarn add install-packages
```

## Usage

```js
const install = require('install-packages')

install({
  packages: ['webpack', 'mocha']
})
//=> Promise
```

## API

### install(options)

#### options

##### packages

Type: `string[]`

You can omit this to install dependencies from `package.json`.

##### cwd

Type: `string`<br>
Default: `process.cwd()`

The directory to install packages.

##### installPeers

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

Install peer dependencies for corresponding dependency.

##### peerFilter

Type: `(name: string, version: string) => boolean`

A function to filter peerDependencies, return `true` to install it, `false` otherwise.

##### saveDev

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

Install as dev dependencies.

##### packageManager

Type: `string`<br>
Possible values: `npm` `yarn`

By default we automatically detect package manager.

### install.determinePackageManager([cwd])

Determine package manager for specifc directory.

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## License

[MIT](https://egoist.mit-license.org/) © [EGOIST](https://github.com/egoist)

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