> 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/~/revisions/27oApOKWT7NW06uHiiU1/aikido-autofix/connect-private-packages/github-registry-private-packages.md).

# NPM - 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 registry to run these updates.

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

### NPM <a href="#npm" id="npm"></a>

For repositories using NPM or PNPM, access to private packages is managed through an `.npmrc` file. The package manager uses the `.npmrc` file to know which registry to use and how to authenticate.

You can either:

* include an `.npmrc` file in your repository, referencing an environment variable for the token.
* provide the `.npmrc` configuration directly in the Aikido interface, [here](#configuration-in-aikido).

If your private package names look like this: `@pied-piper/***` and are hosted on GitHub's npm registry, your file should look something like this:

```
@pied-piper:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=<YOUR_GITHUB_TOKEN>
```

If a `.npmrc` file is set in Aikido, we will write the `.npmrc` file before updating the dependencies. If an `.npmrc` file is present in the repository, it will be overwritten by the `.npmrc` file set in Aikido.

You can find more info about `.npmrc` from NPM [here](https://docs.npmjs.com/cli/v8/configuring-npm/npmrc#auth-related-configuration).

### YARN <a href="#yarn" id="yarn"></a>

If you’re using **Yarn v1**, use the `.npmrc` option in Aikido, [here](#npm). 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:
  aikido-internal-tests:
    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/settings/integrations/autofix).
2. Click on "*Manage Private Registry Connection*", and the configuration modal will now be shown.

   ![Configure access to a private package registry using .npmrc settings.](/files/gcHUB5V1BeZhVWQyZIZ6)
3. Fill in the contents of the `.npmrc` file. The example shows a configuration for multiple scoped packages (`@aikidoSecurity`, `@pied-piper`, and `@internal-tools`) hosted on GitHub Packages.
4. Click "Apply Changes" 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.aikido.dev/~/revisions/27oApOKWT7NW06uHiiU1/aikido-autofix/connect-private-packages/github-registry-private-packages.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.