Skip to main content

Installation and build

Source preview

The repository declares the future package name @kittentts/web, but it is not currently available from the public npm registry. Build it from source and pin a commit.

Requirements​

  • Node.js 20 or later.
  • A modern browser with WebAssembly for browser apps.
  • Emscripten (emcc) when rebuilding the CE phonemizer.

Clone and build​

git clone https://github.com/KittenML/KittenTTS-web.git
cd KittenTTS-web
npm install
npm run build

The build compiles the CE phonemizer, TypeScript sources, and generated runtime files. The package export points to lib/index.js and lib/index.d.ts.

Use in another local project​

During development, pack or link the built repository using your package manager. Keep the application import as:

import {KittenTTS} from '@kittentts/web';

Verify​

npm test
npm run typecheck

The examples are checked into the repository for plain HTML, Vite React, Vite word timings, playback queues, and Node Express.

Last updated on