org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/README.md

   1 npm(1) -- a JavaScript package manager
   2 ==============================
   3 [![Build Status](https://img.shields.io/travis/npm/npm/master.svg)](https://travis-ci.org/npm/npm)
   4 ## SYNOPSIS
   5
   6 This is just enough info to get you up and running.
   7
   8 Much more info available via `npm help` once it's installed.
   9
  10 ## IMPORTANT
  11
  12 **You need node v0.10 or higher to run this program.**
  13
  14 To install an old **and unsupported** version of npm that works on node 0.3
  15 and prior, clone the git repo and dig through the old tags and branches.
  16
  17 **npm is configured to use npm, Inc.'s public package registry at
  18 <https://registry.npmjs.org> by default.**
  19
  20 You can configure npm to use any compatible registry you
  21 like, and even run your own registry. Check out the [doc on
  22 registries](https://docs.npmjs.com/misc/registry).
  23
  24 Use of someone else's registry may be governed by terms of use. The
  25 terms of use for the default public registry are available at
  26 <https://www.npmjs.com>.
  27
  28 ## Super Easy Install
  29
  30 npm is bundled with [node](http://nodejs.org/download/).
  31
  32 ### Windows Computers
  33
  34 [Get the MSI](http://nodejs.org/download/).  npm is in it.
  35
  36 ### Apple Macintosh Computers
  37
  38 [Get the pkg](http://nodejs.org/download/).  npm is in it.
  39
  40 ### Other Sorts of Unices
  41
  42 Run `make install`.  npm will be installed with node.
  43
  44 If you want a more fancy pants install (a different version, customized
  45 paths, etc.) then read on.
  46
  47 ## Fancy Install (Unix)
  48
  49 There's a pretty robust install script at
  50 <https://www.npmjs.com/install.sh>.  You can download that and run it.
  51
  52 Here's an example using curl:
  53
  54 ```sh
  55 curl -L https://www.npmjs.com/install.sh | sh
  56 ```
  57
  58 ### Slightly Fancier
  59
  60 You can set any npm configuration params with that script:
  61
  62 ```sh
  63 npm_config_prefix=/some/path sh install.sh
  64 ```
  65
  66 Or, you can run it in uber-debuggery mode:
  67
  68 ```sh
  69 npm_debug=1 sh install.sh
  70 ```
  71
  72 ### Even Fancier
  73
  74 Get the code with git.  Use `make` to build the docs and do other stuff.
  75 If you plan on hacking on npm, `make link` is your friend.
  76
  77 If you've got the npm source code, you can also semi-permanently set
  78 arbitrary config keys using the `./configure --key=val ...`, and then
  79 run npm commands by doing `node cli.js <cmd> <args>`.  (This is helpful
  80 for testing, or running stuff without actually installing npm itself.)
  81
  82 ## Windows Install or Upgrade
  83
  84 You can download a zip file from <https://github.com/npm/npm/releases>, and
  85 unpack it in the `node_modules\npm\` folder inside node's installation folder.
  86
  87 To upgrade to npm 2, follow the Windows upgrade instructions in
  88 the npm Troubleshooting Guide:
  89
  90 <https://github.com/npm/npm/wiki/Troubleshooting#upgrading-on-windows>
  91
  92 If that's not fancy enough for you, then you can fetch the code with
  93 git, and mess with it directly.
  94
  95 ## Installing on Cygwin
  96
  97 No.
  98
  99 ## Uninstalling
 100
 101 So sad to see you go.
 102
 103 ```sh
 104 sudo npm uninstall npm -g
 105 ```
 106 Or, if that fails,
 107
 108 ```sh
 109 sudo make uninstall
 110 ```
 111
 112 ## More Severe Uninstalling
 113
 114 Usually, the above instructions are sufficient.  That will remove
 115 npm, but leave behind anything you've installed.
 116
 117 If you would like to remove all the packages that you have installed,
 118 then you can use the `npm ls` command to find them, and then `npm rm` to
 119 remove them.
 120
 121 To remove cruft left behind by npm 0.x, you can use the included
 122 `clean-old.sh` script file.  You can run it conveniently like this:
 123
 124 ```sh
 125 npm explore npm -g -- sh scripts/clean-old.sh
 126 ```
 127
 128 npm uses two configuration files, one for per-user configs, and another
 129 for global (every-user) configs.  You can view them by doing:
 130
 131 ```sh
 132 npm config get userconfig   # defaults to ~/.npmrc
 133 npm config get globalconfig # defaults to /usr/local/etc/npmrc
 134 ```
 135
 136 Uninstalling npm does not remove configuration files by default.  You
 137 must remove them yourself manually if you want them gone.  Note that
 138 this means that future npm installs will not remember the settings that
 139 you have chosen.
 140
 141 ## More Docs
 142
 143 Check out the [docs](https://docs.npmjs.com/),
 144 especially the [faq](https://docs.npmjs.com/misc/faq).
 145
 146 You can use the `npm help` command to read any of them.
 147
 148 If you're a developer, and you want to use npm to publish your program,
 149 you should [read this](https://docs.npmjs.com/misc/developers)
 150
 151 ## BUGS
 152
 153 When you find issues, please report them:
 154
 155 * web:
 156   <https://github.com/npm/npm/issues>
 157
 158 Be sure to include *all* of the output from the npm command that didn't work
 159 as expected.  The `npm-debug.log` file is also helpful to provide.
 160
 161 You can also look for isaacs in #node.js on irc://irc.freenode.net.  He
 162 will no doubt tell you to put the output in a gist or email.
 163
 164 ## SEE ALSO
 165
 166 * npm(1)
 167 * npm-faq(7)
 168 * npm-help(1)
 169 * npm-index(7)