> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tortus.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Configure the registry and install the TORTUS Embed SDK.

The SDK is published to **GitHub Packages** under the `@tortus-ai` scope. Installing it is a two-step process: point the `@tortus-ai` scope at GitHub Packages, then install the package.

## Requirements

* A package manager (`npm`, `pnpm`, or `yarn`).
* A **GitHub Personal Access Token** (or an organisation token) with the `read:packages` permission.
* A build target of **ES2020 or newer** (see [Browser support](/reference/security#browser-support)).

## 1. Configure the registry

Create or update `.npmrc` in your project root so the `@tortus-ai` scope resolves to GitHub Packages:

```ini .npmrc theme={null}
@tortus-ai:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
```

<Warning>
  Don't commit a real token to source control. Use an environment variable or your CI secret store,
  for example `//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}`.
</Warning>

## 2. Install the package

<CodeGroup>
  ```bash npm theme={null}
  npm install @tortus-ai/embed-client
  ```

  ```bash pnpm theme={null}
  pnpm add @tortus-ai/embed-client
  ```

  ```bash yarn theme={null}
  yarn add @tortus-ai/embed-client
  ```
</CodeGroup>

## Verify the install

Import the entry point and check your editor picks up the bundled TypeScript types:

```ts theme={null}
import { loadTortus } from '@tortus-ai/embed-client';
```

<Note>
  If you don't have GitHub access, TORTUS can supply an npm-importable package file as an
  alternative. Reach out to [support@tortus.ai](mailto:support@tortus.ai). GitHub Packages remains
  the recommended path.
</Note>

## Next step

<Card title="Authentication" icon="key" href="/authentication">
  Set up the launch token flow before you load the client.
</Card>