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
|
npm-help(1) -- Get help about npm commands
==========================================
## SYNOPSIS
npm help <section>
## DESCRIPTION
`<section>` is one of:
activate
adduser
build
bundle
cache
coding-style
config
deactivate
developers
folders
future-ideas/deploy
future-ideas/remote
future-ideas/site
help
install
json
link
list
ln
ls
npm
owner
publish
rebuild
restart
rm
scripts
start
stop
tag
test
uninstall
unpublish
update
view
## 12-second Intro
You probably got npm because you want to install stuff.
Use `npm install blerg` to install the latest version of "blerg". Check out
`npm help install` for more info. It can do a lot of stuff.
Use the `npm ls` command to show everything that's available. Looking for
express-related modules? `npm ls express`. Looking for the latest express?
`npm ls express latest`. (The arguments are just simple greps.) And of course,
`npm help ls` will tell you more.
Use `npm ls installed` to show everything you've installed.
## Where to go for help
Come bug isaacs in irc://freenode.net#node.js. He'll ask you to copy the npm
output to a pastie or gist, and perhaps to post an issue if it's a new bug.
Failing that, report the issue:
* web:
<http://github.com/isaacs/npm/issues>
* email:
<npm-@googlegroups.com>
If you ask something that's answered by this doc, you may be told to RTFM.
So, save yourself some time and read it now.
## Configs
Use the `npm config` command to manage how npm does stuff and where it puts things.
It stores your configs in the `~/.npmrc` file. Check `npm help config` for more
info on that, if you care.
You can override any config for just a single command by doing `--configname value`
on the command line.
## Developers
If you're using npm to develop and publish your code, check out the following topics:
* json:
Make a package.json file. The "json" help doc will tell you what to put in it.
* link:
For linking your current working code into Node's path, so that you don't have to
reinstall every time you make a change. Use "npm link" to do this.
* install:
It's a good idea to install things if you don't need the symbolic link. Especially,
installing other peoples code from the registry is done via "npm install".
* adduser:
Use the `npm adduser` command to add a user account for the npm registry, or to
authorize yourself on a new machine. If you forget your password, send an email
to <npm-@googlegroups.com> and we'll delete your account so you can recreate it.
* publish:
Use the `npm publish` command to upload your code to the registry, so that other
people can install it easily.
## Contributing
Patches welcome!
* code:
Read through `npm help coding-style` if you plan to submit code. You don't have to
agree with it, but you do have to follow it.
* docs:
If you find an error in the documentation, edit the appropriate markdown file in the
"doc" folder. If you have the "ronn" gem installed, then you can `make doc` to build
the man page, but this is not necessary for your patch to be accepted.
* tests:
The tests are pretty limited. It would be great to perhaps use
something like expresso or vows.
Contributors are listed in npm's `package.json` file.
|
