43 lines
617 B
Markdown
43 lines
617 B
Markdown
|
# user-home [](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)
|