# yarn-install
> Install dependencies using Yarn with npm fallback.
Latest version **1.0.0** (published 2018-04-09) · MIT license · 0 weekly downloads
## Install
```sh
npm install yarn-install
pnpm add yarn-install
yarn add yarn-install
bun add yarn-install
```
Provides the commands `yarn-remove`, `yarn-install`.
## 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 | 1.0.0 |
| Published | 2018-04-09 |
| First published | 2016-10-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 3 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 30 |
| Author | EGOIST |
| Maintainers | rem |
| Keywords | yarn, install |
## Links
- npm: https://www.npmjs.com/package/yarn-install
- Repository: https://github.com/egoist/yarn-install
- npm.io page: https://npm.io/package/yarn-install
## Dependencies (3)
- [cac](https://npm.io/package/cac.md) ^3.0.3
- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^4.0.2
## Recent versions
- 1.0.0 (latest) — 2018-04-09
- 0.5.1 — 2017-07-27
- 0.5.0 — 2017-07-27
- 0.4.2 — 2017-07-27
- 0.4.1 — 2017-07-23
- 0.4.0 — 2017-07-23
- 0.3.0 — 2017-05-02
- 0.2.1 — 2016-11-01
- 0.2.0 — 2016-11-01
- 0.1.1 — 2016-10-28
- 0.1.0 — 2016-10-28
## README
# yarn-install [](https://npmjs.com/package/yarn-install) [](https://npmjs.com/package/yarn-install) [](https://circleci.com/gh/egoist/yarn-install)
If command `yarn` exists it uses Yarn to install, otherwise fallbacks to npm.
## Install
```bash
$ npm install --save yarn-install
```
## Usage
```js
const install = require('yarn-install')
const result = install({
deps: ['webpack', 'mocha']
})
//=> result, returned by child_process.spawnSync
```
## CLI
```bash
yarn global add yarn-install
# then you will have `yarn-install` & `yarn-remove` commands
yarn-install pokemon --dev
yarn-install yo --global
yarn-remove xo
# don't forget that `yarn-install` with dependencies is always `--save` by default.
yarn-install help
yarn-remove help
```
## API
### install([options])
#### options
##### deps
Type: `array`
An array of dependencies to install, you can omit it to install dependencies in `package.json`. If `dependencies` is present, it defaults to `--save` mode.
```js
install({
deps: ['ava', 'koa']
})
```
##### cwd
Type: `string`
The directory to run the command.
##### registry
Type: `string`
Specfic a custom npm registry to use.
##### dev
Type: `boolean`
Use `--dev` for Yarn and `--save-dev` for npm.
##### global
Type: `boolean`
Install globally, stands for `npm --global` or `yarn global`.
##### remove
Type: `boolean`
Default: `undefined`
The reversed behavior to `install`, ie. `yarn remove` and `npm uninstall`
##### production
Type: `boolean`
Default: `undefined`
Only install `dependencies` in `package.json`.
##### respectNpm5
Type: `boolean`
Default: `undefined`
Use npm if it's >= npm5.
### install.getPm([options])
Get the package manager that will be used to install.
#### options
##### respectNpm5
```js
// Given you have yarn & npm 4 installed
const pm = install.getPm()
//=> yarn
// Given you have yarn & npm 5 installed
const pm = install.getPm()
//=> yarn
// Given you have yarn & npm 5 installed
const pm = install.getPm({ respectNpm5: true })
//=> npm
```
## 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/yarn-install · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._