Skip to main content
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).

​
1. Configure the registry

Create or update .npmrc in your project root so the @tortus-ai scope resolves to GitHub Packages:
.npmrc
@tortus-ai:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
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}.

​
2. Install the package

npm install @tortus-ai/embed-client

​
Verify the install

Import the entry point and check your editor picks up the bundled TypeScript types: 
import { loadTortus } from '@tortus-ai/embed-client';
If you don’t have GitHub access, TORTUS can supply an npm-importable package file as an alternative. Reach out to support@tortus.ai. GitHub Packages remains the recommended path.

​
Next step

Authentication

Set up the launch token flow before you load the client.