How to use private Github repo as npm dependency

node.js git github npm package.json
ryanve picture ryanve · Feb 25, 2015 · Viewed 97.9k times · Source

How do I list a private Github repo as a "dependency" in package.json? I tried npm's Github URLs syntaxes like ryanve/example, but doing npm install in the package folder gives "could not install" errors for the private dependencies. Is there a special syntax (or some other mechanism) for depending on private repos?

Answer

ryanve picture ryanve · Feb 25, 2015

It can be done via https and oauth or ssh.

https and oauth: create an access token that has "repo" scope and then use this syntax:

"package-name": "git+https://<github_token>:[email protected]/<user>/<repo>.git"

or

ssh: setup ssh and then use this syntax:

"package-name": "git+ssh://[email protected]:<user>/<repo>.git"

(note the use of colon instead of slash before user)

Related questions

How to publish a npm package with distribution files?

I would like to publish a npm package that contains my source as well as distribution files. My Github repository contains src folder which contains JavaScript source files. The build process generates dist folder that contains the distribution files. Of …

Read More
How can I automatically deploy my app after a git push ( GitHub and node.js)?

I have my application (node.js) deployed on a VPS (linux). I'm using git hub as a repository. How can I deploy the application automatically, on git push ?

Read More
The authenticity of host 'github.com (192.30.252.128)' can't be established

I am trying to use sudo npm install to install all my dependencies for an application written in nodejs. My OS is Ubuntu 13.04 However, I keep getting this warning: The authenticity of host 'github.com (192.30.252.131)' can't be established. RSA …

Read More