Installation

The Circadify Web SDK is distributed as a private npm package on GitHub Packages. Authorized customers install it with npm install @circadify/web-sdk after a one-time .npmrc setup.

Get registry access

@circadify/web-sdk is a private package — you need read access on the @circadify GitHub Packages scope before you can install it.

1. Send Circadify the GitHub username of the engineer (or service account) who will install the SDK. After your enterprise agreement is signed, support grants that user read access on @circadify/web-sdk and confirms by email.

2. Mint a Personal Access Token as the granted user at github.com/settings/tokens/new with the read:packages scope (no other scopes required). Save the ghp_… token — GitHub only shows it once.

3. Configure npm by creating a project-level .npmrc next to your package.json:

   .npmrc

   @circadify:registry=https://npm.pkg.github.com
   //npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

4. Export the token so npm picks it up at install time:

   export GITHUB_TOKEN=ghp_your_read_packages_token

This tells npm that anything under the @circadify scope is fetched from GitHub Packages with your token; every other package continues to come from the public npm registry.

Caution

Never commit a literal token. Use the ${GITHUB_TOKEN} env-var indirection above, or add .npmrc to .gitignore if it must contain a literal value. To rotate or revoke access (e.g. if an engineer leaves), email support@circadify.com with the username to remove and the replacement to add.

Tip

For CI/CD, store the PAT as a secret (GITHUB_TOKEN on GitHub Actions; CIRCADIFY_NPM_TOKEN or similar elsewhere) and reference it from .npmrc. The same .npmrc layout works on every npm-compatible package manager.

Package Manager

Once the registry is configured and your token is exported, install @circadify/web-sdk with your preferred package manager. The SDK ships as ESM with a CommonJS fallback.

npm

npm install @circadify/web-sdk

yarn

yarn add @circadify/web-sdk

pnpm

pnpm add @circadify/web-sdk

Requirements

• Bundle size: ~38 KB (ESM core). WebAssembly modules (~6 MB) are lazy-loaded from CDN on first use and cached by the browser.
• HTTPS: Required for camera access. localhost works during development.
• Browser support:

Browser	Minimum Version
Chrome	80+
Firefox	75+
Safari	14+
Edge	80+

• Required browser APIs:

API	Purpose
WebAssembly	Vision Engine execution (face detection, skin region extraction)
Web Workers	Background frame processing
MediaDevices (navigator.mediaDevices)	Camera stream access
WebGL (optional)	Hardware-accelerated frame processing; falls back to Canvas 2D

TypeScript Support

The SDK ships with full TypeScript definitions included. No additional @types package is needed.

import {
  CircadifySDK,
  CircadifyError,
  CircadifyErrorCode,
  type CircadifyConfig,
  type VitalSignsResult,
  type ProgressEvent,
  type QualityWarning,
} from '@circadify/web-sdk';

All public interfaces, callback signatures, and error types are exported. TypeScript 4.7 or later is recommended for full ESM support.

Next Steps

• Configuration — Configure the SDK for your use case
• Quick Start — End-to-end getting started guide