# homedir

> Platform agnostic user home directory path resolution for Node.js.

Latest version **0.6.0** (published 2014-11-14) · MIT license · 0 weekly downloads

## Install

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

## 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.6.0 |
| Published | 2014-11-14 |
| First published | 2014-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Wil Moore III |
| Maintainers | wilmoore |
| Keywords | userhome, user, home, homedir, home_dir, passwd(5), username, userpath |

## Links

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

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.6.0 (latest) — 2014-11-14
- 0.5.0 — 2014-11-14
- 0.3.0 — 2014-02-22
- 0.2.0 — 2014-02-22
- 0.1.0 — 2014-02-22

## README

# homedir

[![Build Status](http://img.shields.io/travis/wilmoore/node-homedir.svg)](https://travis-ci.org/wilmoore/node-homedir) [![NPM version](http://img.shields.io/npm/v/homedir.svg)](https://www.npmjs.org/package/homedir) [![NPM downloads](http://img.shields.io/npm/dm/homedir.svg)](https://www.npmjs.org/package/homedir) [![LICENSE](http://img.shields.io/npm/l/homedir.svg)](license)

  Platform agnostic user home directory path resolution (i.e. `man 5 passwd`) for [Node.js][].

> The user's home directory. This is the full path name where the user will be placed on login.

#### OSX

    homedir();
    #=> /Users/wilmoore

    homedir('Guest');
    #=> /Users/Guest

#### Windows

    homedir();
    #=> C:\Users\wilmoore

    homedir('Public');
    #=> C:\Users\Public

#### Linux

    homedir();
    #=> /home/wilmoore

    homedir('guest');
    #=> /home/guest

## Installation

    npm install homedir --save

## Alternatives

- [userhome][]
- [home-dir][]


## License

  [MIT](LICENSE)

[userhome]: https://www.npmjs.org/package/userhome
[home-dir]: https://www.npmjs.org/package/home-dir
[Node.js]:  http://nodejs.org

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