# npm-auth

> Utility that sets the npmrc credentials based on environment variables

Latest version **1.1.0** (published 2017-01-08) · MIT license · 0 weekly downloads

## Install

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

Provides the command `npm-auth`.

## 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.1.0 |
| Published | 2017-01-08 |
| First published | 2016-12-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Oleg Shalygin |
| Maintainers | oshalygin |

## Links

- npm: https://www.npmjs.com/package/npm-auth
- Repository: https://github.com/oshalygin/npm-auth
- Homepage: https://github.com/oshalygin/npm-auth#readme
- Issues: https://github.com/oshalygin/npm-auth/issues
- npm.io page: https://npm.io/package/npm-auth

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [minimist](https://npm.io/package/minimist.md) ^1.2.0

## Recent versions

- 1.1.0 (latest) — 2017-01-08
- 1.0.9 — 2017-01-08
- 1.0.8 — 2017-01-03
- 1.0.7 — 2017-01-02
- 1.0.6 — 2017-01-01
- 1.0.5 — 2016-12-26
- 1.0.4 — 2016-12-24
- 1.0.3 — 2016-12-24
- 1.0.2 — 2016-12-24
- 1.0.1 — 2016-12-23
- 1.0.0 — 2016-12-23

## README

# NPM-Auth

[![Build Status](https://travis-ci.org/oshalygin/npm-auth.svg?branch=master)](https://travis-ci.org/oshalygin/npm-auth)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/4d47986f49e94df8a4d33ac07853ab0e)](https://www.codacy.com/app/oshalygin/npm-auth?utm_source=github.com&utm_medium=referral&utm_content=oshalygin/npm-auth&utm_campaign=Badge_Grade)

This utility is used to set the credentials in `.npmrc` locally to authenticate against any public/private NPM Repository.

## Requirements

* This utility depends on various environment variables being set, specifically:
* `NPM_REGISTRY_API_KEY` => the value of `_auth`.
* `NPM_REGISTRY_EMAIL` => the email used to authenticate with.  The default value will be used if this environment variable is not set.
* `NPM_REGISTRY` => the registry that the utility will authenticate against. 

####Installation
---
```bash
    npm install npm-auth
```
####Usage
---
```bash
    # This is the first task that needs to run prior to "npm install"
    npm-auth
```

If you are not setting the properties as environment variables, you are welcome to passing them via the CLI

```bash

  #arguments:
  #   registry        (required): the registry repository, eg: npmjs.org
  #   email           (required): your email address associated to this repositroy, format: you@email.com
  #   secure-token    (required): your api key  which is used to authenticate
  #   file-path       (optional): specify the location to output the configuration file
  #   print           prints the local configuration file


    # Example usage
    npm-auth --registry=http://www.your-private-registry/npm  --secure-token=aasd-123-zasdf-123-sfd --email=you@email.com
    # Note you may pass in just one of the three required parameters if the other parameters are set as Environment variables

    npm-auth --email=you@email.com
    # Also note that anythning passed via the CLI will OVERRIDE the Environment variables, which allows you to flexibibly configure within your CI environment.
    
```
Make sure to ignore the local `.npmrc` from the project solution
---
**.gitignore**
```
# Other ignore files above
.npmrc
``` 

####Development

Start with:
```bash
  npm install
```

Running tests:
```bash
  npm run test
  # Run test with coverage.  The coverage report by default is configured for lcov and can be located in the `./coverage` directory.
  npm run test:cover
```

Command: 
```bash
  npm run push
```

Building the application:
The resulting source code is built to a `./dist` directory which is where the transpiled source resides.  By default the test files are not built to this directory, only the underlying source.  

Command:
```bash
  npm run build
```

####Contributing

Looking to contribute to NPM-Auth?  I love seeing PR's and suggestions, please visit the [CONTRIBUTING](CONTRIBUTING.md) section for more information.

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