Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 145 lines (144 sloc) 3.803 kb
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
1 .\" Generated with Ronnjs/v0.1
2 .\" http://github.com/kapouer/ronnjs/
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
3 .
2881227 @isaacs make doc
isaacs authored
4 .TH "NPM" "1" "November 2010" "" ""
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
5 .
6 .SH "NAME"
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
7 \fBnpm\fR \-\- node package manager
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
8 .
9 .SH "SYNOPSIS"
10 .
11 .nf
12 npm <command> [args]
13 .
14 .fi
15 .
16 .SH "DESCRIPTION"
a3b0aa8 @isaacs Merge the "help" and "npm" man pages.
isaacs authored
17 npm is a package manager for the Node javascript library\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
18 .
19 .P
a3b0aa8 @isaacs Merge the "help" and "npm" man pages.
isaacs authored
20 Run \fBnpm help\fR to get a list of commands\.
2a35c6d @isaacs trim the docs a bit, and organize the changelist
isaacs authored
21 .
4ad295c @isaacs make doc
isaacs authored
22 .SH "STATUS: Useful Beta"
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
23 The core functionality is there\. It works\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
24 .
25 .P
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
26 Please use this software\. It will cut you occasionally\. Let me know when
27 you find a rough edge, and I\'ll sand it down for you\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
28 .
29 .P
9a5519e @isaacs bump version to 0.1.18
isaacs authored
30 I appreciate your sense of adventure\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
31 .
a3b0aa8 @isaacs Merge the "help" and "npm" man pages.
isaacs authored
32 .SH "INTRO"
33 You probably got npm because you want to install stuff\.
34 .
35 .P
36 Use \fBnpm install blerg\fR to install the latest version of "blerg"\. Check out \fBnpm help install\fR for more info\. It can do a lot of stuff\.
37 .
38 .P
39 Use the \fBnpm ls\fR command to show everything that\'s available\. Looking for
40 express\-related modules? \fBnpm ls express\fR\|\. Looking for the latest express? \fBnpm ls express latest\fR\|\. (The arguments are just simple greps\.) And of course, \fBnpm help ls\fR will tell you more\.
41 .
42 .P
43 Use \fBnpm ls installed\fR to show everything you\'ve installed\.
44 .
45 .SH "CONFIGS"
46 Use the \fBnpm config\fR command to manage how npm does stuff and where it puts things\.
47 It stores your configs in the \fB~/\.npmrc\fR file\. Check \fBnpm help config\fR for more
48 info on that, if you care\.
49 .
50 .P
51 You can override any config for just a single command by doing \fB\-\-configname value\fR
52 on the command line\.
53 .
54 .SH "DEVELOPERS"
55 If you\'re using npm to develop and publish your code, check out the following topics:
56 .
57 .IP "\(bu" 4
58 json:
59 Make a package\.json file\. The "json" help doc will tell you what to put in it\.
60 .
61 .IP "\(bu" 4
62 link:
63 For linking your current working code into Node\'s path, so that you don\'t have to
64 reinstall every time you make a change\. Use "npm link" to do this\.
65 .
66 .IP "\(bu" 4
67 install:
68 It\'s a good idea to install things if you don\'t need the symbolic link\. Especially,
69 installing other peoples code from the registry is done via "npm install"\.
70 .
71 .IP "\(bu" 4
72 adduser:
73 Use the \fBnpm adduser\fR command to add a user account for the npm registry, or to
74 authorize yourself on a new machine\. If you forget your password, send an email
75 to \fInpm\-@googlegroups\.com\fR and we\'ll delete your account so you can recreate it\.
76 .
77 .IP "\(bu" 4
78 publish:
79 Use the \fBnpm publish\fR command to upload your code to the registry, so that other
80 people can install it easily\.
81 .
82 .IP "" 0
83 .
84 .SH "CONTRIBUTIONS"
85 Patches welcome!
86 .
87 .IP "\(bu" 4
88 code:
89 Read through \fBnpm help coding\-style\fR if you plan to submit code\. You don\'t have to
90 agree with it, but you do have to follow it\.
91 .
92 .IP "\(bu" 4
93 docs:
94 If you find an error in the documentation, edit the appropriate markdown file in the
95 "doc" folder\. (Don\'t worry about generating the man page\.)
96 .
97 .IP "" 0
98 .
99 .P
100 Contributors are listed in npm\'s \fBpackage\.json\fR file\.
101 .
4ad295c @isaacs make doc
isaacs authored
102 .SH "PRINCIPLES"
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
103 Put the files where they need to be so that node can find them using the
104 methods it already uses\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
105 .
106 .P
9a5519e @isaacs bump version to 0.1.18
isaacs authored
107 Be lazy, not clever\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
108 .
109 .P
9a5519e @isaacs bump version to 0.1.18
isaacs authored
110 The file system is the database\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
111 .
112 .P
9a5519e @isaacs bump version to 0.1.18
isaacs authored
113 Sync with habits that are already in use\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
114 .
115 .P
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
116 Packages should be maintained by their authors, not by the package manager
117 author\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
118 .
119 .P
4ad295c @isaacs make doc
isaacs authored
120 Steer clear of dependency hell\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
121 .
4ad295c @isaacs make doc
isaacs authored
122 .SH "BUGS"
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
123 Plenty\. Luckily, npm is actively maintained as of this writing\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
124 .
125 .P
4ad295c @isaacs make doc
isaacs authored
126 When you find issues, please report them:
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
127 .
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
128 .IP "\(bu" 4
129 web: \fIhttp://github\.com/isaacs/npm/issues\fR
130 .
131 .IP "\(bu" 4
132 email: \fInpm\-@googlegroups\.com\fR
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
133 .
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
134 .IP "" 0
2a35c6d @isaacs trim the docs a bit, and organize the changelist
isaacs authored
135 .
4ad295c @isaacs make doc
isaacs authored
136 .P
f2ccd17 @isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
137 Be sure to include \fIall\fR of the output from the npm command that didn\'t work
138 as expected\.
b70b2a0 @isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
139 .
a3b0aa8 @isaacs Merge the "help" and "npm" man pages.
isaacs authored
140 .P
141 You can also look for isaacs in #node\.js on irc://irc\.freenode\.net\.
142 .
4ad295c @isaacs make doc
isaacs authored
143 .SH "HISTORY"
f39ee04 @isaacs Make doc
isaacs authored
144 See npm\-changelog(1)
Something went wrong with that request. Please try again.