Last active

Embed URL


SSH clone URL

You can clone with HTTPS or SSH.

Download Gist

How to publish packages to NPM


Getting Started with NPM (as a developer)

If you haven't already set your NPM author info, now you should:

npm set "Your Name"
npm set ""
npm set ""

npm adduser

Then create a package.json and publish it:

cd /path/to/your-project
npm init

npm install -g pakmanager
# this shows you dependencies as you `require`d them
pakmanager deps
# now edit `package.json` and add any deps you forgot about

npm publish ./

Beta and Release versions

If you don't want something to install by default

npm publish ./ --tag beta

If you published a bugfix as v1.0.7 and need to set v1.1.3 back to latest

git checkout v1.0.7
npm publish ./

git checkout v1.1.3
npm tag foobar@1.1.3 latest

More Info


If you haven't already installed npm, or you'd like the latest version:


curl | sh


curl | sudo sh

This should be added to NPM docs!



reiz commented


How we can create a npm module with test folder and run test with npm test?
For example, test.js

var assert = require('assert'),
    addmodule = require('../../add');

    function (err, data) {

If I have test.js inside test folder. Does above code of test.js will be run with command npm test in node packaged module?

All you need to do is to add a script attribute in package.json, e.g., add following attribute

"name" : "...",
"scripts": {
    "test": "node ./test/test"

:) awesome, thank you, my first npm just deployed

edit (4 months alter): awesome, helped me again :-) ! thanks


Amazing. This ought to be the no.1 hit on Google for deploying NPM packages. Thanks.


Thanks, it helped me a lot!

mom! I published a package :)

Thanks man!

plouc commented


When doing npm adduser, I got an error saying "Error: default value must be string or number", so I had to edit /home/username/.npmrc to only have:

email =


ixisio commented

+1 Great docs

itomg commented


yeah ! great docs ! I published my npm module successfully with this docs :+1:

+1 Thanks a lot

+1 W√ľnderbar



Thanks! I published my first npm module with your doc :)

+another 1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.