# napa

> A helper for installing repos without a package.json with npm.

Latest version **3.0.0** (published 2017-06-11) · MIT license · 0 weekly downloads

## Install

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

Provides the command `napa`.

## 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 | 3.0.0 |
| Published | 2017-06-11 |
| First published | 2013-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0 |
| Dependencies | 10 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 412 |
| Author | Kyle Robinson Young |
| Maintainers | caseywebb, shama, tomekwi |
| Keywords | npm, install, assets |

## Links

- npm: https://www.npmjs.com/package/napa
- Repository: https://github.com/shama/napa
- Issues: https://github.com/shama/napa/issues
- npm.io page: https://npm.io/package/napa

## Dependencies (10)

- [extend](https://npm.io/package/extend.md) ^3.0.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [npmlog](https://npm.io/package/npmlog.md) ^4.1.0
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.1
- [download](https://npm.io/package/download.md) ^6.2.2
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [tar-pack](https://npm.io/package/tar-pack.md) ^3.4.0
- [load-json-file](https://npm.io/package/load-json-file.md) ^2.0.0
- [write-json-file](https://npm.io/package/write-json-file.md) ^2.2.0
- [npm-cache-filename](https://npm.io/package/npm-cache-filename.md) ^1.0.2

## Recent versions

- 3.0.0 (latest) — 2017-06-11
- 2.3.0 — 2016-01-30
- 2.2.0 — 2015-12-10
- 2.1.0 — 2015-12-10
- 2.0.2 — 2015-10-26
- 2.0.1 — 2015-10-07
- 2.0.0 — 2015-10-06
- 1.2.0 — 2015-01-07
- 1.1.0 — 2014-12-10
- 1.0.2 — 2014-10-29
- 1.0.1 — 2014-10-08
- 1.0.0 — 2014-10-08
- 0.4.1 — 2014-03-13
- 0.4.0 — 2014-02-20
- 0.3.0 — 2014-01-24
- … 3 more at https://npm.io/package/napa/versions

## README

# napa [![Build Status](http://img.shields.io/travis/shama/napa.svg?label=Travis%20CI%20build)](https://travis-ci.org/shama/napa) [![AppVeyor](https://img.shields.io/appveyor/ci/shama/napa.svg?label=AppVeyor%20build)](https://ci.appveyor.com/project/shama/napa/branch/master) [![Code Climate](https://img.shields.io/codeclimate/coverage/github/shama/napa.svg)](https://codeclimate.com/github/shama/napa) [![David](https://img.shields.io/david/shama/napa.svg)](https://david-dm.org/shama/napa) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)

A helper for installing repos without a `package.json` with npm.

[![NPM](https://nodei.co/npm/napa.png?downloads=true)](https://nodei.co/npm/napa/)

## usage

Install with `npm install napa --save-dev` then setup your local `package.json` scripts as such:

```json
{
  "scripts": {
    "install": "napa username/repo"
  }
}
```

Now when you run `npm install` it will `git clone git://github.com/username/repo node_modules/repo`.

### Want to name the package something else?

```json
{
  "scripts": {
    "install": "napa username/repo:adifferentname"
  }
}
```

Now it will install to `node_modules/adifferentname`.

### Want to install a package not on github?

```json
{
  "scripts": {
    "install": "napa git://example.com/user/repo:privatepackage"
  }
}
```

### Multiple packages?

```json
{
  "scripts": {
    "install": "napa user/repo1:dude user/repo2:rad user/repo3:cool"
  }
}
```

### Prefer a more structured approach?

```json
{
  "scripts": {
    "install": "napa"
  },
  "napa": {
    "foo": "username/repo",
    "bar": "git@example.com:user/repo"
  }
}
```

### Looking to just download a tagged release/a branch/a specific commit on github or just a zip or tar.gz url?

```json
{
  "scripts": {
    "install": "napa"
  },
  "napa": {
    "foo": "username/repo#v1.2.3",
    "bar": "username/bar#some-branch",
    "baz": "username/baz#347259472813400c7a982690acaa516292a8be40",
    "qoo": "https://example.com/downloads/release.tar.gz",
    "fuz": "git+https://yourcompany.com/repos/project.git",
    "goo": "git+ssh://yourcompany.com/repos/project.git"
  }
}
```

### Additional configuration

The application currently supports the following configuration options under a `napa-config` property in `package.json`.

Option name | Default value | Desctiption
---|---|---
`cache` | `true` | Set to `false` to completely disable package caching
`cache-path` | [`'<OS temp>/cache'`](https://github.com/shama/napa/blob/master/lib/pkg.js#L8) | Override default path to a specific location<br>(relative to the current working directory)
`log-level` | `'info'`  | Set the log level: `'silent'`/`'error'`/`'warn'`/`'verbose'`/`'silly'`

```json
{
  "napa-config": {
    "cache": false,
    "cache-path": "../.napa-cache",
    "log-level": "error"
  }
}
```

### Using Node.js < 4?
Please use `npm install napa@2.3.0` and upgrade your Node.js.

## Release History

Please view https://github.com/shama/napa/commits/master for history.

* `2.0.1` - Fix path must be a string error ([@caseyWebb](//github.com/caseyWebb)).
* `2.0.0` - Better detection for GitHub repos, fixes when creating a `package.json`, cached git `#tag` urls now get updated properly ([@tomekwi](//github.com/tomekwi)). Add config options for disabling cache or setting cache path ([@bbsbb](//github.com/bbsbb)). Fix for npm 3 erroring when `.git` folder present ([@caseyWebb](//github.com/caseyWebb)). Updating dependencies.
* `1.2.0` - Callback optional with CLI and do not ignore `.gitignore` files when unpacking ([@dai-shi](//github.com/dai-shi)).
* `1.1.0` - Upgrade download for better downloads behind proxies ([@msieurtoph](//github.com/msieurtoph)).
* `1.0.2` - Fix references to git specifiers. Thanks [@jsdevel](//github.com/jsdevel)!
* `1.0.1` - Fix path to CLI.
* `1.0.0` - Avoids duplicate installs and will install from cache.
* `0.4.1` - Fix git reporting non-errors on stderr by running in quiet mode.
* `0.4.0` - Add `strip: 1` when downloading to avoid untarring within a sub-directory. Thanks [@seei](//github.com/seei)!
* `0.3.0` - Ability to download packages using any URL
* `0.2.0` - Ability to set packages using napa key in `package.json`
* `0.1.1` - `--depth 1` for faster cloning
* `0.1.0` - initial release

## License
Copyright (c) 2017 Kyle Robinson Young
Licensed under the MIT license.

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