org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/man/man1/npm.1

   1 .TH "NPM" "1" "October 2016" "" ""
   2 .SH "NAME"
   3 \fBnpm\fR \- javascript package manager
   4 .SH SYNOPSIS
   5 .P
   6 .RS 2
   7 .nf
   8 npm <command> [args]
   9 .fi
  10 .RE
  11 .SH VERSION
  12 .P
  13 2.15.11
  14 .SH DESCRIPTION
  15 .P
  16 npm is the package manager for the Node JavaScript platform\.  It puts
  17 modules in place so that node can find them, and manages dependency
  18 conflicts intelligently\.
  19 .P
  20 It is extremely configurable to support a wide variety of use cases\.
  21 Most commonly, it is used to publish, discover, install, and develop node
  22 programs\.
  23 .P
  24 Run \fBnpm help\fP to get a list of available commands\.
  25 .SH INTRODUCTION
  26 .P
  27 You probably got npm because you want to install stuff\.
  28 .P
  29 Use \fBnpm install blerg\fP to install the latest version of "blerg"\.  Check out
  30 npm help \fBnpm\-install\fP for more info\.  It can do a lot of stuff\.
  31 .P
  32 Use the \fBnpm search\fP command to show everything that's available\.
  33 Use \fBnpm ls\fP to show everything you've installed\.
  34 .SH DEPENDENCIES
  35 .P
  36 If a package references to another package with a git URL, npm depends
  37 on a preinstalled git\.
  38 .P
  39 If one of the packages npm tries to install is a native node module and
  40 requires compiling of C++ Code, npm will use
  41 node\-gyp \fIhttps://github\.com/TooTallNate/node\-gyp\fR for that task\.
  42 For a Unix system, node\-gyp \fIhttps://github\.com/TooTallNate/node\-gyp\fR
  43 needs Python, make and a buildchain like GCC\. On Windows,
  44 Python and Microsoft Visual Studio C++ are needed\. Python 3 is
  45 not supported by node\-gyp \fIhttps://github\.com/TooTallNate/node\-gyp\fR\|\.
  46 For more information visit
  47 the node\-gyp repository \fIhttps://github\.com/TooTallNate/node\-gyp\fR and
  48 the node\-gyp Wiki \fIhttps://github\.com/TooTallNate/node\-gyp/wiki\fR\|\.
  49 .SH DIRECTORIES
  50 .P
  51 See npm help 5 \fBnpm\-folders\fP to learn about where npm puts stuff\.
  52 .P
  53 In particular, npm has two modes of operation:
  54 .RS 0
  55 .IP \(bu 2
  56 global mode:
  57 .br
  58 npm installs packages into the install prefix at
  59 \fBprefix/lib/node_modules\fP and bins are installed in \fBprefix/bin\fP\|\.
  60 .IP \(bu 2
  61 local mode:
  62 .br
  63 npm installs packages into the current project directory, which
  64 defaults to the current working directory\.  Packages are installed to
  65 \fB\|\./node_modules\fP, and bins are installed to \fB\|\./node_modules/\.bin\fP\|\.
  66
  67 .RE
  68 .P
  69 Local mode is the default\.  Use \fB\-\-global\fP or \fB\-g\fP on any command to
  70 operate in global mode instead\.
  71 .SH DEVELOPER USAGE
  72 .P
  73 If you're using npm to develop and publish your code, check out the
  74 following help topics:
  75 .RS 0
  76 .IP \(bu 2
  77 json:
  78 Make a package\.json file\.  See npm help 5 \fBpackage\.json\fP\|\.
  79 .IP \(bu 2
  80 link:
  81 For linking your current working code into Node's path, so that you
  82 don't have to reinstall every time you make a change\.  Use
  83 \fBnpm link\fP to do this\.
  84 .IP \(bu 2
  85 install:
  86 It's a good idea to install things if you don't need the symbolic link\.
  87 Especially, installing other peoples code from the registry is done via
  88 \fBnpm install\fP
  89 .IP \(bu 2
  90 adduser:
  91 Create an account or log in\.  Credentials are stored in the
  92 user config file\.
  93 .IP \(bu 2
  94 publish:
  95 Use the \fBnpm publish\fP command to upload your code to the registry\.
  96
  97 .RE
  98 .SH CONFIGURATION
  99 .P
 100 npm is extremely configurable\.  It reads its configuration options from
 101 5 places\.
 102 .RS 0
 103 .IP \(bu 2
 104 Command line switches:
 105 .br
 106 Set a config with \fB\-\-key val\fP\|\.  All keys take a value, even if they
 107 are booleans (the config parser doesn't know what the options are at
 108 the time of parsing\.)  If no value is provided, then the option is set
 109 to boolean \fBtrue\fP\|\.
 110 .IP \(bu 2
 111 Environment Variables:
 112 .br
 113 Set any config by prefixing the name in an environment variable with
 114 \fBnpm_config_\fP\|\.  For example, \fBexport npm_config_key=val\fP\|\.
 115 .IP \(bu 2
 116 User Configs:
 117 .br
 118 The file at $HOME/\.npmrc is an ini\-formatted list of configs\.  If
 119 present, it is parsed\.  If the \fBuserconfig\fP option is set in the cli
 120 or env, then that will be used instead\.
 121 .IP \(bu 2
 122 Global Configs:
 123 .br
 124 The file found at \.\./etc/npmrc (from the node executable, by default
 125 this resolves to /usr/local/etc/npmrc) will be parsed if it is found\.
 126 If the \fBglobalconfig\fP option is set in the cli, env, or user config,
 127 then that file is parsed instead\.
 128 .IP \(bu 2
 129 Defaults:
 130 .br
 131 npm's default configuration options are defined in
 132 lib/utils/config\-defs\.js\.  These must not be changed\.
 133
 134 .RE
 135 .P
 136 See npm help 7 \fBnpm\-config\fP for much much more information\.
 137 .SH CONTRIBUTIONS
 138 .P
 139 Patches welcome!
 140 .RS 0
 141 .IP \(bu 2
 142 code:
 143 Read through npm help 7 \fBnpm\-coding\-style\fP if you plan to submit code\.
 144 You don't have to agree with it, but you do have to follow it\.
 145 .IP \(bu 2
 146 docs:
 147 If you find an error in the documentation, edit the appropriate markdown
 148 file in the "doc" folder\.  (Don't worry about generating the man page\.)
 149
 150 .RE
 151 .P
 152 Contributors are listed in npm's \fBpackage\.json\fP file\.  You can view them
 153 easily by doing \fBnpm view npm contributors\fP\|\.
 154 .P
 155 If you would like to contribute, but don't know what to work on, read
 156 the contributing guidelines and check the issues list\.
 157 .RS 0
 158 .IP \(bu 2
 159 https://github\.com/npm/npm/wiki/Contributing\-Guidelines
 160 .IP \(bu 2
 161 https://github\.com/npm/npm/issues
 162
 163 .RE
 164 .SH BUGS
 165 .P
 166 When you find issues, please report them:
 167 .RS 0
 168 .IP \(bu 2
 169 web:
 170 https://github\.com/npm/npm/issues
 171
 172 .RE
 173 .P
 174 Be sure to include \fIall\fR of the output from the npm command that didn't work
 175 as expected\.  The \fBnpm\-debug\.log\fP file is also helpful to provide\.
 176 .P
 177 You can also look for isaacs in #node\.js on irc://irc\.freenode\.net\.  He
 178 will no doubt tell you to put the output in a gist or email\.
 179 .SH AUTHOR
 180 .P
 181 Isaac Z\. Schlueter \fIhttp://blog\.izs\.me/\fR ::
 182 isaacs \fIhttps://github\.com/isaacs/\fR ::
 183 @izs \fIhttp://twitter\.com/izs\fR ::
 184 i@izs\.me
 185 .SH SEE ALSO
 186 .RS 0
 187 .IP \(bu 2
 188 npm help help
 189 .IP \(bu 2
 190 npm help 7 faq
 191 .IP \(bu 2
 192 README
 193 .IP \(bu 2
 194 npm help 5 package\.json
 195 .IP \(bu 2
 196 npm help install
 197 .IP \(bu 2
 198 npm help config
 199 .IP \(bu 2
 200 npm help 7 config
 201 .IP \(bu 2
 202 npm help 5 npmrc
 203 .IP \(bu 2
 204 npm help 7 index
 205 .IP \(bu 2
 206 npm apihelp npm
 207
 208 .RE
 209