tools/eslint/node_modules/user-home/readme.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

# user-home [![Build Status](https://travis-ci.org/sindresorhus/user-home.svg?branch=master)](https://travis-ci.org/sindresorhus/user-home)

> Get the path to the user home directory


## Install

```sh
$ npm install --save user-home
```


## Usage

```js
var userHome = require('user-home');

console.log(userHome);
//=> /Users/sindresorhus
```

Returns `null` in the unlikely scenario that the home directory can't be found.


## CLI

```sh
$ npm install --global user-home
```

```sh
$ user-home --help

Example
  $ user-home
  /Users/sindresorhus
```


## License

MIT © [Sindre Sorhus](http://sindresorhus.com)