Install specific branch from github using Npm

Question

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

lest · Accepted Answer · 2021-11-12T09:26:12.857

426

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

edited Nov 12 '21 at 09:26

answered Sep 27 '16 at 19:06

lest

7,780
2
24
22

6

if we had to attach the specific version. then how would it be along with branch? – Md_Zubair Ahmed Mar 25 '18 at 10:02
2

@Md_ZubairAhmed The branch name in his example just happened to be named "v1" -- it could be named something else like "my-branch", and behave the same way. – Venryx Oct 23 '19 at 07:18
5

If you want to install a specific comit, you can do: `npm install https://github.com/username/package#3d0a21cc` Where `3d0a21cc` are the first eight characters of the commit hash. I found this answer [here](https://stackoverflow.com/a/51560215/6086226) – Derk Jan Speelman Feb 13 '20 at 09:33
4

For info, github has removed the [git:// procotol](https://github.blog/2021-09-01-improving-git-protocol-security-github/#no-more-unauthenticated-git) so you cannot use this method anymore. You should omit the protocol and let npm detect that it is a github repository (see the answer just below : `npm install username/repo#branchName --save`) – Nicolas D Nov 02 '21 at 16:19

Xin · Answer 2 · 2022-01-27T03:10:59.480

124

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.

edited Jan 27 '22 at 03:10

answered Jun 07 '18 at 06:30

Xin

33,823
14
84
85

1

Any chance you could do this for a package within a monorepo? – Paul Razvan Berg Dec 07 '19 at 18:39
@PaulRazvanBerg Yes, you can do `npm install ` – Thilak Rao Jan 29 '20 at 12:52
Does not work: npm i facebook/https://github.com/facebook/jest.git#master --save. Or this: npm i facebook/[email protected]:facebook/jest.git#master --save. Does not work either – Daniel Viglione Mar 22 '20 at 17:37
@Donato Please follow the pattern in the example – Xin Mar 23 '20 at 02:49
@Xin it doesn't work: npm i facebook/jest#master --save ERR! Can't install github:facebook/jest#b5c7092687a265e3f4f2ba6f9787e47e8c6b9d5e: Missing package name – Daniel Viglione Mar 23 '20 at 04:21
It works on other packages, which I have just tried. meaning their should be some setting wrong in that package – Xin Mar 23 '20 at 04:52
@Xin this is the most popular JavaScript Testing Framework. This is not just a random package. – Daniel Viglione Mar 23 '20 at 13:46
1

it may be because of package private in package.json or other settings, you can fork that repo, and remove all doubtable settings, then connect to your branch. That's some of my thought. @Donato – Xin Mar 25 '20 at 09:50

mkg · Answer 3 · 2018-10-24T13:31:32.363

44

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

edited Oct 24 '18 at 13:31

answered Apr 03 '18 at 10:01

mkg

769
7
9

1

Doesn't work. Try the following: npm i jest@facebook/[email protected]:facebook/jest.git#master – Daniel Viglione Mar 22 '20 at 17:35

score 14 · Answer 4 · answered Jun 09 '19 at 14:30

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

Esteban Borai · Answer 5 · 2021-03-05T14:53:40.623

10

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>"
}

edited Mar 05 '21 at 14:53

answered Dec 18 '19 at 15:50

Esteban Borai

2,311
1
21
27

1

Thanks! Just a comment this is the way I added using npm i. (notice the *:* instead of */* between github.com and the user name) *npm i git+ssh://[email protected]:/.git#* – Sebastian Oscar Lopez Sep 06 '20 at 15:12

score 5 · Answer 6 · answered Jun 05 '20 at 00:58

5

Had to put the url in quotes for it work

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

answered Jun 05 '20 at 00:58

user2643679

706
12
18

Artjom Kurapov · Answer 7 · 2019-12-31T08:23:29.657

3

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

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

edited Dec 31 '19 at 08:23

answered Dec 29 '19 at 16:19

Artjom Kurapov

6,115
4
32
42

2

Add some explanation with answer for how this answer help OP in fixing current issue – ρяσѕρєя K Dec 30 '19 at 00:18

score 2 · Answer 8 · answered Mar 08 '22 at 11:49

2

Only solution working for me:

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

as explained here.

answered Mar 08 '22 at 11:49

Frugan

319
4
7

mpro · Answer 9 · 2023-01-04T14:40:22.727

-1

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/"

edited Jan 04 '23 at 14:40

answered Jan 04 '23 at 14:28

mpro

14,302
5
28
43

score -7 · Answer 10 · answered Sep 11 '17 at 13:57

-7

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

answered Sep 11 '17 at 13:57

menepet

796
13
17

5

The documents clearly state that `#commitish` is allowed for `npm install ` – kͩeͣmͮpͥ ͩ Nov 14 '17 at 10:06

Install specific branch from github using Npm

10 Answers10

Linked