Search code examples
node.jsyarnpkg

How to install package from github repo in Yarn

When I use npm install fancyapps/fancybox#v2.6.1 --save, the 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 the following command the right alternative? There is nothing about this format in yarn docs.

yarn add fancyapps/fancybox#v2.6.1
Solution

  • 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