How to specify local registry in yarn?

Question

I have a local nexus server, I'd like yarn to look through it before going online, basically prefer-offline

yarn install \
  --prefer-offline \
  --cache-folder C:\folder\yarn-cache \
  --preferred-cache-folder C:\folder\yarn-cache \
  --non-interactive \
  --no-lockfile \
  --registry http://server/repository/npm-group

Yarn fails to find a dependency offline then fails to go online. I don't know if that can be fixed.

Have you resolved your issue? – Dawid Sawa Sep 03 '18 at 13:30 — Dawid Sawa, Sep 03 '18 at 13:30

score 51 · Accepted Answer · edited Oct 01 '21 at 16:59

Create an npm (hosted) repository to use as your private registry. I believe you have already done this.
Create an npm (proxy) repository pointing to your external repository of choice (https://registry.yarnpkg.com or https://registry.npmjs.org/).
Create an npm (group) with your private registry on first position and the proxy registry on second position.
Point yarn to your group repository: yarn config set registry http://nexus.local/repository/npm-group/. If required by your Nexus configuration, authenticate yarn: yarn login.

Also be wary of yarn using any npm config you might have over it's own: https://github.com/yarnpkg/yarn/issues/4862

Update for Yarn v2+:

Yarn v2+ uses a different configuration key for updating the NPM registry, called npmRegistryServer (see their Migration page for details):

yarn config set npmRegistryServer http://nexus.local/repository/npm-group/

3

What about the authToken? – geoidesic Jul 26 '22 at 16:20

score 37 · Answer 2 · answered Oct 21 '19 at 05:32

37

You can set a different registry in yarn by using the following command:

yarn config set registry <url-to-your-registry>

Verify that it has been set by typing the following command:

yarn config get registry

For a one-off change in registry you can use the variable YARN_REGISTRY like this:

YARN_REGISTRY="<url-to-your-registry>" yarn config get registry

or

YARN_REGISTRY="<url-to-your-registry>" yarn publish

answered Oct 21 '19 at 05:32

Vishal Vasnani

501
4
7

3

Thanks. This was a head scratcher since the docs say `--registry` on the cli for a one-off. – forivall Nov 25 '19 at 21:35
1

Welcome, I faced the same issue when I was trying it. Felt like this should be posted as an answer here. – Vishal Vasnani Dec 17 '19 at 09:33

score 8 · Answer 3 · answered Dec 03 '20 at 11:01

8

You can use .yarnrc file & add registry "<your repo URL>" Refer - yarnrc

answered Dec 03 '20 at 11:01

Shabbir Essaji

584
1
10
17

1

the file itself says "do not edit this file directly" - `yarn config set registry` is preferred – John Vandivier Jul 11 '21 at 20:24

score 3 · Answer 4 · answered Aug 07 '20 at 10:03

3

Heads up!

If you define your publishConfig.registry in package.json:

  "publishConfig": {
    "registry": "https://registry.npmjs.org"
  },

It will still override registry, even if --registry param was given to yarn publish!

answered Aug 07 '20 at 10:03

cadavre

1,334
1
18
34

score 3 · Answer 5 · answered Mar 16 '22 at 14:41

3

Also don't forget to regenerate yarn.lock file after changing registry. It's neccessary because yarn.lock contains links to old registry and will try to install dependencies from that links.

answered Mar 16 '22 at 14:41

Alex Belov

31
3

shrekuu · Answer 6 · 2023-07-29T03:44:13.203

Hey Yarn 1 users

If you want to config a registry for a specific repo, it should go to the .npmrc file in your repo. .yarnrc is supposed to configure additional Yarn features
However It's OK if you put it in .yarnrc file. Yarn will read both .npmrc and .yarnrc file.
If you want to config registry globally, run the following command(eg: I am using https://registry.npmmirror.com registry):
```
yarn config set registry https://registry.npmmirror.com
```
Note this add registry to the .yarnrc your user home directory (~/.yarnrc). The added line is like this:
```
registry "https://registry.npmmirror.com"
```

For Yarn 2 users, try this answer.

For NPM users

Config registry for a repo:

npm config --location=project set registry https://registry.npmmirror.com

Config registry globally(~/.npmrc):

npm config --location=global set registry https://registry.npmmirror.com

`--location=local` is not a valid option for location, it's one of these three: `global`, `user`, `project`. — Sgnl, Nov 14 '22 at 19:29

score 1 · Answer 7 · answered Feb 06 '23 at 17:45

1

In the case of yarn 3 a.k.a. Berry:

yarn config set 'npmRegistries["http://npm.example.com"]'

answered Feb 06 '23 at 17:45

kn_pavan

1,510
3
21
42

How to specify local registry in yarn?

7 Answers7

Hey Yarn 1 users

For NPM users

Linked