www.aleph1.co.uk Git - yaffs-website/blob - node_modules/user-home/readme.md

   1 # user-home [![Build Status](https://travis-ci.org/sindresorhus/user-home.svg?branch=master)](https://travis-ci.org/sindresorhus/user-home)
   2
   3 > Get the path to the user home directory
   4
   5
   6 ## Install
   7
   8 ```sh
   9 $ npm install --save user-home
  10 ```
  11
  12
  13 ## Usage
  14
  15 ```js
  16 var userHome = require('user-home');
  17
  18 console.log(userHome);
  19 //=> /Users/sindresorhus
  20 ```
  21
  22 Returns `null` in the unlikely scenario that the home directory can't be found.
  23
  24
  25 ## CLI
  26
  27 ```sh
  28 $ npm install --global user-home
  29 ```
  30
  31 ```sh
  32 $ user-home --help
  33
  34 Example
  35   $ user-home
  36   /Users/sindresorhus
  37 ```
  38
  39
  40 ## License
  41
  42 MIT © [Sindre Sorhus](http://sindresorhus.com)