6.5 KiB

Raw Blame History

npm-faq(1) -- Frequently Asked Questions

Where can I find these docs in HTML?

npm config set viewer browser

to open these documents in your default web browser rather than man.

It didn't work.

That's not really a question.

Why didn't it work?

I don't know yet.

Read the error output, and if you can't figure out what it means, do what it says and post a bug with all the information it asks for.

Where does npm put stuff?

See npm-folders(1)

tl;dr:

Use the npm root command to see where modules go, and the npm bin command to see where executables go
Global installs are different from local installs. If you install something with the -g flag, then its executables go in npm bin -g and its modules go in npm root -g.

How do I install something everywhere?

Install it globally by tacking -g or --global to the command.

I installed something globally, but I can't `require()` it

Install it locally.

I don't wanna.

Check out npm link. You might like it.

No, I really want 0.x style 'everything global' style.

Ok, fine. Do this:

echo 'export NODE_PATH="'$(npm root -g)'"' >> ~/.bashrc
. ~/.bashrc
npm config set global true

This is not recommended.

Many things will not work if you do this. Make sure you read and understand npm-config(1) and npm-global(1) before you complain about things being broken.

When you realize what a mistake it was, do this to switch back:

npm config delete global --local

If 'npm' is an acronym, why is it never capitalized?

Contrary to the belief of many, "npm" is not in fact an abbreviation for "Node Package Manager". It is a recursive bacronymic abbreviation for "npm is not an acronym". (If it was "ninaa", then it would be an acronym, and thus incorrectly named.)

"NPM", however, is an acronym (more precisely, a capitonym) for the National Association of Pastoral Musicians. You can learn more about them at http://npm.org/.

In software, "NPM" is a non-parametric mapping utility written by Chris Rorden. You can analyze pictures of brains with it. Learn more about the (capitalized) NPM program at http://www.cabiatl.com/mricro/npm/.

The first seed that eventually grew into this flower was a bash utility named "pm", which was a shortened descendent of "pkgmakeinst", a bash function that was used to install various different things on different platforms, most often using Yahoo's yinst. If npm was ever an acronym for anything, it was node pm or maybe new pm.

So, in all seriousness, the "npm" project is named after its command-line utility, which was organically selected to be easily typed by a right-handed programmer using a US QWERTY keyboard layout, ending with the right-ring-finger in a postition to type the - key for flags and other command-line arguments. That command-line utility is always lower-case, though it starts most sentences it is a part of.

How do I list installed packages?

npm ls

How do I search for packages?

npm search

Arguments are greps. npm search jsdom shows jsdom packages.

How do I update npm?

npm update npm -g

You can also update all outdated local packages by doing npm update without any arguments, or global packages by doing npm update -g.

Occasionally, the version of npm will progress such that the current version cannot be properly installed with the version that you have installed already. (Consider, if there is ever a bug in the update command.)

In those cases, you can do this:

curl http://npmjs.org/install.sh | sh

What is a `package`?

A package is:

a) a folder containing a program described by a package.json file
b) a gzipped tarball containing (a)
c) a url that resolves to (b)
d) a <name>@<version> that is published on the registry with (c)
e) a <name>@<tag> that points to (d)
f) a <name> that has a "latest" tag satisfying (e)
g) a git url that, when cloned, results in (a).

Even if you never publish your package, you can still get a lot of benefits of using npm if you just want to write a node program (a), and perhaps if you also want to be able to easily install it elsewhere after packing it up into a tarball (b).

Git urls can be of the form:

git://github.com/user/project.git#commit-ish
git+ssh://user@hostname:project.git#commit-ish
git+http://user@hostname/project/blah.git#commit-ish
git+https://user@hostname/project/blah.git#commit-ish

The commit-ish can be any tag, sha, or branch which can be supplied as an argument to git checkout. The default is master.

How do I install node with npm?

You don't. Try one of these:

How can I use npm for development?

See npm-developers(1) and npm-json(1).

You'll most likely want to npm link your development folder. That's awesomely handy.

To set up your own private registry, check out npm-registry(1).

Can I list a url as a dependency?

Yes. It should be a url to a gzipped tarball containing a single folder that has a package.json in its root, or a git url. (See "what is a package?" above.)

How do I symlink to a dev folder so I don't have to keep re-installing?

See npm-link(1)

The package registry website. What is that exactly?

See npm-registry(1).

What's up with the insecure channel warnings?

Until node 0.4.10, there were problems sending big files over HTTPS. That means that publishes go over HTTP by default in those versions of node.

I forgot my password, and can't publish. How do I reset it?

Go to http://admin.npmjs.org/reset.

I get ECONNREFUSED a lot. What's up?

Either the registry is down, or node's DNS isn't able to reach out. This happens a lot if you don't follow all the steps in the Cygwin setup doc.

To check if the registry is down, open up http://registry.npmjs.org/-/short in a web browser. This will also tell you if you are just unable to access the internet for some reason.

If the registry IS down, let me know by emailing or posting an issue. We'll have someone kick it or something.

Who does npm?

npm view npm author

npm view npm contributors

I have a question or request not addressed here. Where should I put it?

Discuss it on the mailing list, or post an issue.

Why does npm hate me?

npm is not capable of hatred. It loves everyone, especially you.

6.5 KiB Raw Blame History