# node-netrc

> Higher-level ~/.netrc parser

Latest version **0.1.0** (published 2015-07-26) · 0 weekly downloads

## Install

```sh
npm install node-netrc
pnpm add node-netrc
yarn add node-netrc
bun add node-netrc
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-07-26 |
| First published | 2014-07-02 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Matthew Mueller |
| Maintainers | mattmueller, dominicbarnes |

## Links

- npm: https://www.npmjs.com/package/node-netrc
- Repository: https://github.com/duojs/node-netrc
- Issues: https://github.com/duojs/node-netrc/issues
- npm.io page: https://npm.io/package/node-netrc

## Dependencies (1)

- [netrc](https://npm.io/package/netrc.md) ^0.1.3

## Recent versions

- 0.1.0 (latest) — 2015-07-26
- 0.0.1 — 2014-07-02

## README

# node-netrc

[![npm version](https://img.shields.io/npm/v/node-netrc.svg)](https://npmjs.org/package/node-netrc)
[![build status](https://img.shields.io/travis/duojs/node-netrc.svg)](https://travis-ci.org/duojs/node-netrc)

> Higher-level `~/.netrc` parser


## Example

```js
var netrc = require('node-netrc');

// read auth from ~/.netrc
var auth = netrc('api.github.com');
auth.login // ...
auth.password // ...

// merge new config into ~/.netrc
netrc.update('api.github.com', {
  login: 'user',
  password: 'pass'
});
```


## API

### netrc([host])

Return the `login` and `password` details of `host`. Or return `false`.

If no `host`, return all the hosts.

### netrc.update(host, data)

Updates the netrc with the given `data` for `host`. (`data` usually contains
`login` and `password`, but any given props will be written)

If `data` is empty, the given `host` will be removed from the file.

**NOTE:** this method merges data with what is already in place, it will **not**
affect any other hosts.


## Testing

```sh
npm install
make test
```


## License

(The MIT License)

Copyright (c) 2014 Matthew Mueller <mattmuelle@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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