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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
<!doctype html>
<html>
<title>npm-index</title>
<meta http-equiv="content-type" value="text/html;utf-8">
<link rel="stylesheet" type="text/css" href="../../static/style.css">
<link rel="canonical" href="https://www.npmjs.org/doc/misc/npm-index.html">
<script async=true src="../../static/toc.js"></script>
<body>
<div id="wrapper">
<h1><a href="../misc/npm-index.html">npm-index</a></h1> <p>Index of all npm documentation</p>
<h3 id="readme-1-"><a href="../../doc/README.html"><a href="../../doc/README.html">README</a></a></h3>
<p>a JavaScript package manager</p>
<h2 id="command-line-documentation">Command Line Documentation</h2>
<p>Using npm on the command line</p>
<h3 id="npm-1-"><a href="../cli/npm.html"><a href="../cli/npm.html">npm(1)</a></a></h3>
<p>javascript package manager</p>
<h3 id="npm-access-1-"><a href="../cli/npm-access.html"><a href="../cli/npm-access.html">npm-access(1)</a></a></h3>
<p>Set access level on published packages</p>
<h3 id="npm-adduser-1-"><a href="../cli/npm-adduser.html"><a href="../cli/npm-adduser.html">npm-adduser(1)</a></a></h3>
<p>Add a registry user account</p>
<h3 id="npm-bin-1-"><a href="../cli/npm-bin.html"><a href="../cli/npm-bin.html">npm-bin(1)</a></a></h3>
<p>Display npm bin folder</p>
<h3 id="npm-bugs-1-"><a href="../cli/npm-bugs.html"><a href="../cli/npm-bugs.html">npm-bugs(1)</a></a></h3>
<p>Bugs for a package in a web browser maybe</p>
<h3 id="npm-build-1-"><a href="../cli/npm-build.html"><a href="../cli/npm-build.html">npm-build(1)</a></a></h3>
<p>Build a package</p>
<h3 id="npm-bundle-1-"><a href="../cli/npm-bundle.html"><a href="../cli/npm-bundle.html">npm-bundle(1)</a></a></h3>
<p>REMOVED</p>
<h3 id="npm-cache-1-"><a href="../cli/npm-cache.html"><a href="../cli/npm-cache.html">npm-cache(1)</a></a></h3>
<p>Manipulates packages cache</p>
<h3 id="npm-completion-1-"><a href="../cli/npm-completion.html"><a href="../cli/npm-completion.html">npm-completion(1)</a></a></h3>
<p>Tab Completion for npm</p>
<h3 id="npm-config-1-"><a href="../cli/npm-config.html"><a href="../cli/npm-config.html">npm-config(1)</a></a></h3>
<p>Manage the npm configuration files</p>
<h3 id="npm-dedupe-1-"><a href="../cli/npm-dedupe.html"><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></a></h3>
<p>Reduce duplication</p>
<h3 id="npm-deprecate-1-"><a href="../cli/npm-deprecate.html"><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></a></h3>
<p>Deprecate a version of a package</p>
<h3 id="npm-dist-tag-1-"><a href="../cli/npm-dist-tag.html"><a href="../cli/npm-dist-tag.html">npm-dist-tag(1)</a></a></h3>
<p>Modify package distribution tags</p>
<h3 id="npm-docs-1-"><a href="../cli/npm-docs.html"><a href="../cli/npm-docs.html">npm-docs(1)</a></a></h3>
<p>Docs for a package in a web browser maybe</p>
<h3 id="npm-edit-1-"><a href="../cli/npm-edit.html"><a href="../cli/npm-edit.html">npm-edit(1)</a></a></h3>
<p>Edit an installed package</p>
<h3 id="npm-explore-1-"><a href="../cli/npm-explore.html"><a href="../cli/npm-explore.html">npm-explore(1)</a></a></h3>
<p>Browse an installed package</p>
<h3 id="npm-help-search-1-"><a href="../cli/npm-help-search.html"><a href="../cli/npm-help-search.html">npm-help-search(1)</a></a></h3>
<p>Search npm help documentation</p>
<h3 id="npm-help-1-"><a href="../cli/npm-help.html"><a href="../cli/npm-help.html">npm-help(1)</a></a></h3>
<p>Get help on npm</p>
<h3 id="npm-init-1-"><a href="../cli/npm-init.html"><a href="../cli/npm-init.html">npm-init(1)</a></a></h3>
<p>Interactively create a package.json file</p>
<h3 id="npm-install-1-"><a href="../cli/npm-install.html"><a href="../cli/npm-install.html">npm-install(1)</a></a></h3>
<p>Install a package</p>
<h3 id="npm-link-1-"><a href="../cli/npm-link.html"><a href="../cli/npm-link.html">npm-link(1)</a></a></h3>
<p>Symlink a package folder</p>
<h3 id="npm-logout-1-"><a href="../cli/npm-logout.html"><a href="../cli/npm-logout.html">npm-logout(1)</a></a></h3>
<p>Log out of the registry</p>
<h3 id="npm-ls-1-"><a href="../cli/npm-ls.html"><a href="../cli/npm-ls.html">npm-ls(1)</a></a></h3>
<p>List installed packages</p>
<h3 id="npm-outdated-1-"><a href="../cli/npm-outdated.html"><a href="../cli/npm-outdated.html">npm-outdated(1)</a></a></h3>
<p>Check for outdated packages</p>
<h3 id="npm-owner-1-"><a href="../cli/npm-owner.html"><a href="../cli/npm-owner.html">npm-owner(1)</a></a></h3>
<p>Manage package owners</p>
<h3 id="npm-pack-1-"><a href="../cli/npm-pack.html"><a href="../cli/npm-pack.html">npm-pack(1)</a></a></h3>
<p>Create a tarball from a package</p>
<h3 id="npm-prefix-1-"><a href="../cli/npm-prefix.html"><a href="../cli/npm-prefix.html">npm-prefix(1)</a></a></h3>
<p>Display prefix</p>
<h3 id="npm-prune-1-"><a href="../cli/npm-prune.html"><a href="../cli/npm-prune.html">npm-prune(1)</a></a></h3>
<p>Remove extraneous packages</p>
<h3 id="npm-publish-1-"><a href="../cli/npm-publish.html"><a href="../cli/npm-publish.html">npm-publish(1)</a></a></h3>
<p>Publish a package</p>
<h3 id="npm-rebuild-1-"><a href="../cli/npm-rebuild.html"><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></a></h3>
<p>Rebuild a package</p>
<h3 id="npm-repo-1-"><a href="../cli/npm-repo.html"><a href="../cli/npm-repo.html">npm-repo(1)</a></a></h3>
<p>Open package repository page in the browser</p>
<h3 id="npm-restart-1-"><a href="../cli/npm-restart.html"><a href="../cli/npm-restart.html">npm-restart(1)</a></a></h3>
<p>Restart a package</p>
<h3 id="npm-rm-1-"><a href="../cli/npm-rm.html"><a href="../cli/npm-rm.html">npm-rm(1)</a></a></h3>
<p>Remove a package</p>
<h3 id="npm-root-1-"><a href="../cli/npm-root.html"><a href="../cli/npm-root.html">npm-root(1)</a></a></h3>
<p>Display npm root</p>
<h3 id="npm-run-script-1-"><a href="../cli/npm-run-script.html"><a href="../cli/npm-run-script.html">npm-run-script(1)</a></a></h3>
<p>Run arbitrary package scripts</p>
<h3 id="npm-search-1-"><a href="../cli/npm-search.html"><a href="../cli/npm-search.html">npm-search(1)</a></a></h3>
<p>Search for packages</p>
<h3 id="npm-shrinkwrap-1-"><a href="../cli/npm-shrinkwrap.html"><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></a></h3>
<p>Lock down dependency versions</p>
<h3 id="npm-star-1-"><a href="../cli/npm-star.html"><a href="../cli/npm-star.html">npm-star(1)</a></a></h3>
<p>Mark your favorite packages</p>
<h3 id="npm-stars-1-"><a href="../cli/npm-stars.html"><a href="../cli/npm-stars.html">npm-stars(1)</a></a></h3>
<p>View packages marked as favorites</p>
<h3 id="npm-start-1-"><a href="../cli/npm-start.html"><a href="../cli/npm-start.html">npm-start(1)</a></a></h3>
<p>Start a package</p>
<h3 id="npm-stop-1-"><a href="../cli/npm-stop.html"><a href="../cli/npm-stop.html">npm-stop(1)</a></a></h3>
<p>Stop a package</p>
<h3 id="npm-tag-1-"><a href="../cli/npm-tag.html"><a href="../cli/npm-tag.html">npm-tag(1)</a></a></h3>
<p>Tag a published version</p>
<h3 id="npm-test-1-"><a href="../cli/npm-test.html"><a href="../cli/npm-test.html">npm-test(1)</a></a></h3>
<p>Test a package</p>
<h3 id="npm-uninstall-1-"><a href="../cli/npm-uninstall.html"><a href="../cli/npm-uninstall.html">npm-uninstall(1)</a></a></h3>
<p>Remove a package</p>
<h3 id="npm-unpublish-1-"><a href="../cli/npm-unpublish.html"><a href="../cli/npm-unpublish.html">npm-unpublish(1)</a></a></h3>
<p>Remove a package from the registry</p>
<h3 id="npm-update-1-"><a href="../cli/npm-update.html"><a href="../cli/npm-update.html">npm-update(1)</a></a></h3>
<p>Update a package</p>
<h3 id="npm-version-1-"><a href="../cli/npm-version.html"><a href="../cli/npm-version.html">npm-version(1)</a></a></h3>
<p>Bump a package version</p>
<h3 id="npm-view-1-"><a href="../cli/npm-view.html"><a href="../cli/npm-view.html">npm-view(1)</a></a></h3>
<p>View registry info</p>
<h3 id="npm-whoami-1-"><a href="../cli/npm-whoami.html"><a href="../cli/npm-whoami.html">npm-whoami(1)</a></a></h3>
<p>Display npm username</p>
<h2 id="api-documentation">API Documentation</h2>
<p>Using npm in your Node programs</p>
<h3 id="npm-3-"><a href="../api/npm.html"><a href="../api/npm.html">npm(3)</a></a></h3>
<p>javascript package manager</p>
<h3 id="npm-bin-3-"><a href="../api/npm-bin.html"><a href="../api/npm-bin.html">npm-bin(3)</a></a></h3>
<p>Display npm bin folder</p>
<h3 id="npm-bugs-3-"><a href="../api/npm-bugs.html"><a href="../api/npm-bugs.html">npm-bugs(3)</a></a></h3>
<p>Bugs for a package in a web browser maybe</p>
<h3 id="npm-cache-3-"><a href="../api/npm-cache.html"><a href="../api/npm-cache.html">npm-cache(3)</a></a></h3>
<p>manage the npm cache programmatically</p>
<h3 id="npm-commands-3-"><a href="../api/npm-commands.html"><a href="../api/npm-commands.html">npm-commands(3)</a></a></h3>
<p>npm commands</p>
<h3 id="npm-config-3-"><a href="../api/npm-config.html"><a href="../api/npm-config.html">npm-config(3)</a></a></h3>
<p>Manage the npm configuration files</p>
<h3 id="npm-deprecate-3-"><a href="../api/npm-deprecate.html"><a href="../api/npm-deprecate.html">npm-deprecate(3)</a></a></h3>
<p>Deprecate a version of a package</p>
<h3 id="npm-docs-3-"><a href="../api/npm-docs.html"><a href="../api/npm-docs.html">npm-docs(3)</a></a></h3>
<p>Docs for a package in a web browser maybe</p>
<h3 id="npm-edit-3-"><a href="../api/npm-edit.html"><a href="../api/npm-edit.html">npm-edit(3)</a></a></h3>
<p>Edit an installed package</p>
<h3 id="npm-explore-3-"><a href="../api/npm-explore.html"><a href="../api/npm-explore.html">npm-explore(3)</a></a></h3>
<p>Browse an installed package</p>
<h3 id="npm-help-search-3-"><a href="../api/npm-help-search.html"><a href="../api/npm-help-search.html">npm-help-search(3)</a></a></h3>
<p>Search the help pages</p>
<h3 id="npm-init-3-"><a href="../api/npm-init.html"><a href="../api/npm-init.html">npm-init(3)</a></a></h3>
<p>Interactively create a package.json file</p>
<h3 id="npm-install-3-"><a href="../api/npm-install.html"><a href="../api/npm-install.html">npm-install(3)</a></a></h3>
<p>install a package programmatically</p>
<h3 id="npm-link-3-"><a href="../api/npm-link.html"><a href="../api/npm-link.html">npm-link(3)</a></a></h3>
<p>Symlink a package folder</p>
<h3 id="npm-load-3-"><a href="../api/npm-load.html"><a href="../api/npm-load.html">npm-load(3)</a></a></h3>
<p>Load config settings</p>
<h3 id="npm-ls-3-"><a href="../api/npm-ls.html"><a href="../api/npm-ls.html">npm-ls(3)</a></a></h3>
<p>List installed packages</p>
<h3 id="npm-outdated-3-"><a href="../api/npm-outdated.html"><a href="../api/npm-outdated.html">npm-outdated(3)</a></a></h3>
<p>Check for outdated packages</p>
<h3 id="npm-owner-3-"><a href="../api/npm-owner.html"><a href="../api/npm-owner.html">npm-owner(3)</a></a></h3>
<p>Manage package owners</p>
<h3 id="npm-pack-3-"><a href="../api/npm-pack.html"><a href="../api/npm-pack.html">npm-pack(3)</a></a></h3>
<p>Create a tarball from a package</p>
<h3 id="npm-prefix-3-"><a href="../api/npm-prefix.html"><a href="../api/npm-prefix.html">npm-prefix(3)</a></a></h3>
<p>Display prefix</p>
<h3 id="npm-prune-3-"><a href="../api/npm-prune.html"><a href="../api/npm-prune.html">npm-prune(3)</a></a></h3>
<p>Remove extraneous packages</p>
<h3 id="npm-publish-3-"><a href="../api/npm-publish.html"><a href="../api/npm-publish.html">npm-publish(3)</a></a></h3>
<p>Publish a package</p>
<h3 id="npm-rebuild-3-"><a href="../api/npm-rebuild.html"><a href="../api/npm-rebuild.html">npm-rebuild(3)</a></a></h3>
<p>Rebuild a package</p>
<h3 id="npm-repo-3-"><a href="../api/npm-repo.html"><a href="../api/npm-repo.html">npm-repo(3)</a></a></h3>
<p>Open package repository page in the browser</p>
<h3 id="npm-restart-3-"><a href="../api/npm-restart.html"><a href="../api/npm-restart.html">npm-restart(3)</a></a></h3>
<p>Restart a package</p>
<h3 id="npm-root-3-"><a href="../api/npm-root.html"><a href="../api/npm-root.html">npm-root(3)</a></a></h3>
<p>Display npm root</p>
<h3 id="npm-run-script-3-"><a href="../api/npm-run-script.html"><a href="../api/npm-run-script.html">npm-run-script(3)</a></a></h3>
<p>Run arbitrary package scripts</p>
<h3 id="npm-search-3-"><a href="../api/npm-search.html"><a href="../api/npm-search.html">npm-search(3)</a></a></h3>
<p>Search for packages</p>
<h3 id="npm-shrinkwrap-3-"><a href="../api/npm-shrinkwrap.html"><a href="../api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></a></h3>
<p>programmatically generate package shrinkwrap file</p>
<h3 id="npm-start-3-"><a href="../api/npm-start.html"><a href="../api/npm-start.html">npm-start(3)</a></a></h3>
<p>Start a package</p>
<h3 id="npm-stop-3-"><a href="../api/npm-stop.html"><a href="../api/npm-stop.html">npm-stop(3)</a></a></h3>
<p>Stop a package</p>
<h3 id="npm-tag-3-"><a href="../api/npm-tag.html"><a href="../api/npm-tag.html">npm-tag(3)</a></a></h3>
<p>Tag a published version</p>
<h3 id="npm-test-3-"><a href="../api/npm-test.html"><a href="../api/npm-test.html">npm-test(3)</a></a></h3>
<p>Test a package</p>
<h3 id="npm-uninstall-3-"><a href="../api/npm-uninstall.html"><a href="../api/npm-uninstall.html">npm-uninstall(3)</a></a></h3>
<p>uninstall a package programmatically</p>
<h3 id="npm-unpublish-3-"><a href="../api/npm-unpublish.html"><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></a></h3>
<p>Remove a package from the registry</p>
<h3 id="npm-update-3-"><a href="../api/npm-update.html"><a href="../api/npm-update.html">npm-update(3)</a></a></h3>
<p>Update a package</p>
<h3 id="npm-version-3-"><a href="../api/npm-version.html"><a href="../api/npm-version.html">npm-version(3)</a></a></h3>
<p>Bump a package version</p>
<h3 id="npm-view-3-"><a href="../api/npm-view.html"><a href="../api/npm-view.html">npm-view(3)</a></a></h3>
<p>View registry info</p>
<h3 id="npm-whoami-3-"><a href="../api/npm-whoami.html"><a href="../api/npm-whoami.html">npm-whoami(3)</a></a></h3>
<p>Display npm username</p>
<h2 id="files">Files</h2>
<p>File system structures npm uses</p>
<h3 id="npm-folders-5-"><a href="../files/npm-folders.html"><a href="../files/npm-folders.html">npm-folders(5)</a></a></h3>
<p>Folder Structures Used by npm</p>
<h3 id="npmrc-5-"><a href="../files/npmrc.html"><a href="../files/npmrc.html">npmrc(5)</a></a></h3>
<p>The npm config files</p>
<h3 id="package-json-5-"><a href="../files/package.json.html"><a href="../files/package.json.html">package.json(5)</a></a></h3>
<p>Specifics of npm's package.json handling</p>
<h2 id="misc">Misc</h2>
<p>Various other bits and bobs</p>
<h3 id="npm-coding-style-7-"><a href="../misc/npm-coding-style.html"><a href="../misc/npm-coding-style.html">npm-coding-style(7)</a></a></h3>
<p>npm's "funny" coding style</p>
<h3 id="npm-config-7-"><a href="../misc/npm-config.html"><a href="../misc/npm-config.html">npm-config(7)</a></a></h3>
<p>More than you probably want to know about npm configuration</p>
<h3 id="npm-developers-7-"><a href="../misc/npm-developers.html"><a href="../misc/npm-developers.html">npm-developers(7)</a></a></h3>
<p>Developer Guide</p>
<h3 id="npm-disputes-7-"><a href="../misc/npm-disputes.html"><a href="../misc/npm-disputes.html">npm-disputes(7)</a></a></h3>
<p>Handling Module Name Disputes</p>
<h3 id="npm-faq-7-"><a href="../misc/npm-faq.html"><a href="../misc/npm-faq.html">npm-faq(7)</a></a></h3>
<p>Frequently Asked Questions</p>
<h3 id="npm-index-7-"><a href="../misc/npm-index.html"><a href="../misc/npm-index.html">npm-index(7)</a></a></h3>
<p>Index of all npm documentation</p>
<h3 id="npm-registry-7-"><a href="../misc/npm-registry.html"><a href="../misc/npm-registry.html">npm-registry(7)</a></a></h3>
<p>The JavaScript Package Registry</p>
<h3 id="npm-scope-7-"><a href="../misc/npm-scope.html"><a href="../misc/npm-scope.html">npm-scope(7)</a></a></h3>
<p>Scoped packages</p>
<h3 id="npm-scripts-7-"><a href="../misc/npm-scripts.html"><a href="../misc/npm-scripts.html">npm-scripts(7)</a></a></h3>
<p>How npm handles the "scripts" field</p>
<h3 id="removing-npm-7-"><a href="../misc/removing-npm.html"><a href="../misc/removing-npm.html">removing-npm(7)</a></a></h3>
<p>Cleaning the Slate</p>
<h3 id="semver-7-"><a href="../misc/semver.html"><a href="../misc/semver.html">semver(7)</a></a></h3>
<p>The semantic versioner for npm</p>
</div>
<table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
<tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
<tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
<tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
<tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
<tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
<tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
<tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
</table>
<p id="footer">npm-index — npm@2.11.0</p>
|
