CODEWITHSUNDEEP
githubnpm-install
Sachin
Sachin

Reputation: 5091

Install specific branch from github using Npm

I would like to install bootstrap-loader from github in my project using npm

Currently they are maintaining two version of this project which are comaptible with webpack version 1 and 2.

I would like to install version 1. What npm command I should use to install this?

I tried using below one but it is not working.

npm install git://github.com/shakacode/bootstrap-loader.git[#v1] --Save

Upvotes: 318

Views: 226195

Answers (10)

mpro
mpro

Reputation: 15050

Both below versions work for me as of beginning of 2023:

npm i "github:shakacode#bootstrap-loader"

npm i "https://github.com/shakacode/tree/bootstrap-loader/"

Upvotes: -1

Frugan
Frugan

Reputation: 389

Only solution working for me:

$ npm i https://github.com/{USER}/{REPO}/tarball/{BRANCH} --save

as explained here.

Upvotes: 4

Xin
Xin

Reputation: 36610

npm: npm install username/repo#branchName --save

yarn: yarn add username/repo#branchName

e.g. npm i betimer/rtc-attach#master --save (my username is betimer)

// this will appear in your package.json:
"rtc-attach": "github:betimer/rtc-attach#master"

One thing I also want to mention: it's not a good idea to check in the package.json for the build server auto pull the change. Instead, put the npm i (first command) into the build command, and let server just install and replace the package.

One more note, if the package.json private is set to true, may impact sometimes.

Upvotes: 133

lest
lest

Reputation: 8100

There are extra square brackets in the command you tried.

To install the latest version from the brach-name branch, you can use:

npm install "https://github.com/shakacode/bootstrap-loader.git#branch-name" --save

Upvotes: 456

Leo Borai
Leo Borai

Reputation: 2509

I'm using SSH to authenticate my GitHub account and have a couple dependencies in my project installed as follows:

"dependencies": {
  "<dependency name>": "git+ssh://[email protected]/<github username>/<repository name>.git#<release version | branch>"
}

Upvotes: 10

user2643679
user2643679

Reputation: 705

Had to put the url in quotes for it work

npm install "https://github.com/shakacode/bootstrap-loader.git#v1" --save

Upvotes: 5

Artjom Kurapov
Artjom Kurapov

Reputation: 6155

Tried suggested answers, but got it working only with this prefix approach:

npm i github:user/repo.git#version --save -D

Upvotes: 3

Ilarion Halushka
Ilarion Halushka

Reputation: 2343

Another approach would be to add the following line to package.json dependencies:

"package-name": "user/repo#branch"

For example:

"dependencies": {
    ... other dependencies ...

    "react-native": "facebook/react-native#master"
}

And then do npm install or yarn install

Upvotes: 18

mkg
mkg

Reputation: 779

you can give git pattern as version, yarn and npm are clever enough to resolve from a git repo.

yarn add any-package@user-name/repo-name#branch-name

or for npm

npm install --save any-package@user-name/repo-name#branch-name

Upvotes: 45

menepet
menepet

Reputation: 882

The Doc of the npm defines that only tag/version can be specified after repo_url.

Here is the Doc: https://docs.npmjs.com/cli/install

Upvotes: -6

Related Questions