# Installation

Install the private Astro OpenAPI package from GitHub Packages.

import { Callout, Steps } from '@prosefly/astro-components';

<Callout type="warning" title="Sponsor access required">
  Astro OpenAPI is published as a private package. You need a GitHub account
  with package read access and a token with the `read:packages` scope.
</Callout>

## Configure the registry

Add the Prosefly scope to your project-level `.npmrc`:

```ini title=".npmrc"
@prosefly:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
```

Keep `GITHUB_TOKEN` outside the repository. In CI, provide it through the
platform's secret manager.

## Install the package

<Steps>

1. Confirm that your GitHub account has access to the private package.

2. Set `GITHUB_TOKEN` in your local shell or package-manager environment.

3. Install Astro OpenAPI alongside Astro and Astro Components.

   ```sh
   pnpm add @prosefly/astro-openapi @prosefly/astro-components
   ```

</Steps>

<Callout type="tip" title="Keep the token private">
  Do not commit a token to `.npmrc`, lockfiles, CI output, or client-side code.
</Callout>