> For the complete documentation index, see [llms.txt](https://help.aikido.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aikido.dev/autofix-and-remediation/connect-private-packages/yarn-private-packages.md).

# Yarn - Private Packages

When Aikido updates dependencies in repositories that use private packages, it needs access to those packages to correctly update your lockfiles. You can configure Aikido to authenticate with your private NPM registry to run these updates.

## Prerequisites <a href="#prerequisites" id="prerequisites"></a>

If you’re using **Yarn v1**, use the `.npmrc` option in Aikido as described in [the NPM & PNPM documentation](/autofix-and-remediation/connect-private-packages/npm-private-packages.md). For **Yarn v2 and newer**, use the `.yarnrc.yml` file to configure private package access.

### **Configuring `.yarnrc.yml`**

Private package access is defined in a `.yarnrc.yml` file in your project. This file declares `npmScopes` for your private packages and specifies which registry they use.

If a `.yarnrc.yml` file is set in Aikido, we write the `.yarnrc.yml` file next to your `yarn.lock` file before updating the dependencies. If the `.yarnrc.yml` file is pressent in the repository, it will be overwritten by the `.yarnrc.yml` file set in Aikido.

Example `.yarnrc.yml`

```yaml
npmScopes:
  piedPiper:
    npmAuthToken: "<YOUR_GITHUB_TOKEN>"
    npmRegistryServer: "https://npm.pkg.github.com"
```

You can find more information in the Yarn documentation [here](https://yarnpkg.com/configuration/yarnrc#npmScopes).

## Configuration in Aikido <a href="#configuration-in-aikido" id="configuration-in-aikido"></a>

To allow repositories using private packages to be updated, provide your private registry configuration in the Aikido UI. Aikido stores the credentials encrypted and credentials cannot be retrieved through the Aikido UI or API.

1. Go to *Autofix* > *Settings* in Aikido, [here](https://app.aikido.dev/issues/fix/settings).
2. Click on "*Connect Registry*", and the selection modal will now be shown.

<figure><img src="https://3149773201-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyKbzcQGrx7UtrG0nPZZ7%2Fuploads%2Fgit-blob-9266e8da54be5ee4e49440d10a643bfa587a37ac%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

3. Select Yarn to input your `.yarnrc.yml` file. (Note that for Yarn V1, you will need to select NPM.)

<figure><img src="https://3149773201-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyKbzcQGrx7UtrG0nPZZ7%2Fuploads%2Fgit-blob-3e3f35a01be38f1f9093b9efca63159b5ade7ead%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

4. Fill in the contents of the `.yarnrc.yml` file. The example shows a configuration for GitHub Packages in the piedPiper GitHub organisation.
5. Click "*Connect Registry*" to save the configuration.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.aikido.dev/autofix-and-remediation/connect-private-packages/yarn-private-packages.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
