How to install package from github repo in Yarn

Question

When I use npm install fancyapps/fancybox#v2.6.1 --save, so fancybox package at v2.6.1 tag will be installed. This behavior is described in docs

I want to ask, how to do this with yarn?

Is this command the right alternative? In yarn docs isn't anything about this format.

yarn add fancyapps/fancybox#v2.6.1

score 347 · Accepted Answer · edited Nov 05 '20 at 03:10

347

You can add any Git repository (or tarball) as a dependency to yarn by specifying the remote URL (either HTTPS or SSH):

yarn add <git remote url> installs a package from a remote git repository.
yarn add <git remote url>#<branch/commit/tag> installs a package from a remote git repository at specific git branch, git commit or git tag.
yarn add https://my-project.org/package.tgz installs a package from a remote gzipped tarball.

Here are some examples:

yarn add https://github.com/fancyapps/fancybox [remote url]
yarn add ssh://github.com/fancyapps/fancybox#3.0  [branch]
yarn add https://github.com/fancyapps/fancybox#5cda5b529ce3fb6c167a55d42ee5a316e921d95f [commit]

(Note: Fancybox v2.6.1 isn't available in the Git version.)

To support both npm and yarn, you can use the git+url syntax:

git+https://github.com/owner/package.git#commithashortagorbranch
git+ssh://github.com/owner/package.git#commithashortagorbranch

edited Nov 05 '20 at 03:10

Community

1
1

answered Apr 26 '17 at 14:07

Kasiriveni

5,671
1
22
31

6

but can not use git@xxx style – Jiang YD Jul 28 '18 at 03:24
If the SSH option was added to this answer we could probably lose all of the others. – toxaq Aug 19 '19 at 06:06
Don't forget you can use semantic versioning! `yarn add https://github.com/fancyapps/fancybox.git#semver:^3.0` This will pull the latest major version, which is currently 3.5.7. – Elte156 Aug 23 '19 at 02:21
2

Adding a dist folder might be needed as well for resolving the module. – oligopol Jan 08 '20 at 09:44
11

For SSH with private repository, i found we need to add user `git`. e.g: `yarn add ssh://git@github.com/fancyapps/fancybox#3.0` – GusDeCooL Jul 24 '20 at 15:15
Is there a way to do that in package.json? – Kévin Sanchez Lacroix Aug 13 '20 at 13:04
7

This doesn't work in Yarn 2; you need to add `my-package-name@` in front of the url. See here: https://github.com/yarnpkg/berry/issues/994#issuecomment-591853492 – Venryx Jun 22 '21 at 09:28
@oligopol is there any way not to have dist folder on github and still be able to use git repo as a dependency? Like building after yarn downloads the files – Luka Samkharadze Nov 17 '21 at 14:53

score 49 · Answer 2 · edited Aug 18 '22 at 15:03

49

Yarn 2+

Installing from remote URLs has changed slightly with Yarn 2. Specifically, remote URLs must be prefixed with the package name. So for github this means:

yarn add '<package name>@https://github.com/<github user>/<github repo>'

Make sure that <package name> matches the value in the "name" field of the repo's package.json file.

To target a specific branch add either head=<branch> or commit=<full commit hash> via the URL fragment:

yarn add '<package name>@https://github.com/<github user>/<github repo>#head=<branch name>'

If you're trying to install an individual package from a Yarn monorepo on github you can add workspace=<package name> to the URL fragment:

yarn add '<package name>@https://github.com/<github user>/<github repo>#head=<branch name>&workspace=<package name>'

edited Aug 18 '22 at 15:03

Ray

2,713
3
29
61

answered May 31 '21 at 20:31

Elliot

1,463
1
14
14

how to install from PR? – CodeBy Jun 14 '21 at 14:50
@CodeBy replace /#head= with the source user/repo/branch of the PR – Elliot Jun 15 '21 at 12:47
will name the package with those <> you should remove it. it is not within the syntax – Amr Feb 10 '22 at 04:03

score 34 · Answer 3 · answered Sep 28 '18 at 19:16

34

For ssh style urls just add ssh before the url:

yarn add ssh://<whatever>@<xxx>#<branch,tag,commit>

answered Sep 28 '18 at 19:16

Tyler

1,705
2
18
26

10

This worked for me when `yarn` refused to honor the common `git` ssh url syntax: Did work: `yarn add ssh://git@github.com:my-org/my-repo#commit_hash` Did not work: `yarn add git@github.com:my-org/my-repo#commit_hash` – kilogic Oct 01 '18 at 16:19
1

Is there a way to do that but from package.json with yarn install? – Kévin Sanchez Lacroix Aug 13 '20 at 13:05

score 21 · Answer 4 · answered Apr 22 '17 at 21:51

21

This is described here: https://yarnpkg.com/en/docs/cli/add#toc-adding-dependencies

For example:

yarn add https://github.com/novnc/noVNC.git#0613d18

answered Apr 22 '17 at 21:51

lanwen

2,251
1
17
30

score 15 · Answer 5 · answered Feb 05 '19 at 20:55

15

For GitHub (or similar) private repository:

yarn add 'ssh://git@github.com:myproject.git#<branch,tag,commit>'
npm install 'ssh://git@github.com:myproject.git#<branch,tag,commit>'

answered Feb 05 '19 at 20:55

Eduardo Cuomo

17,828
6
117
94

score 11 · Answer 6 · answered Feb 17 '20 at 00:51

11

I use this short format for github repositories:

yarn add github_user/repository_name#commit_hash

answered Feb 17 '20 at 00:51

betoharres

1,736
2
19
25

score 2 · Answer 7 · answered Dec 01 '22 at 20:34

With the latest version of Yarn, they require a package name before the URL. If you're installing a private package that you published to Github Packages, the syntax is like this:

yarn add @organization/packagename@https://github.com/organization/packagename,

Which should yield this line in package.json:

"@organization/packagename": "https://github.com/organization/packagename"

How to install package from github repo in Yarn

7 Answers7

Yarn 2+

Linked