# whisper-node-ts

> Node bindings for OpenAI's Whisper. Optimized for CPU.

Latest version **0.0.16** (published 2023-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install whisper-node-ts
pnpm add whisper-node-ts
yarn add whisper-node-ts
bun add whisper-node-ts
```

Provides the command `download`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.16 |
| Published | 2023-08-18 |
| First published | 2023-08-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 3.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | sunshineLixun |
| Maintainers | lixun_f |
| Keywords | OpenAI, Whisper, CPP, C++, Whisper, Bindings, Transcript, Transcriber, Audio, Speech, Speech-to-Text, STT, TTS, SRT, diarization |

## Links

- npm: https://www.npmjs.com/package/whisper-node-ts
- Repository: https://github.com/sunshineLixun/whisper-node-ts
- Homepage: https://npmjs.com/whisper-node-ts
- Issues: https://github.com/sunshineLixun/whisper-node-ts/issues
- npm.io page: https://npm.io/package/whisper-node-ts

## Dependencies (4)

- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.10
- [@types/shelljs](https://npm.io/package/@types/shelljs.md) ^0.8.12
- [@types/readline-sync](https://npm.io/package/@types/readline-sync.md) ^1.4.4

## Recent versions

- 0.0.16 (latest) — 2023-08-18
- 0.0.15 — 2023-08-18
- 0.0.12 — 2023-08-18
- 0.0.11 — 2023-08-18
- 0.0.4 — 2023-08-18
- 0.0.2 — 2023-08-18
- 0.0.1 — 2023-08-18

## README

# whisper-node-ts

[![npm downloads](https://www.npmjs.com/package/whisper-node-ts)](https://www.npmjs.com/package/whisper-node-ts)
[![npm downloads](https://img.shields.io/npm/l/whisper-node-ts)](https://www.npmjs.com/package/whisper-node-ts)

Node.js bindings for OpenAI's Whisper.

Base on [whisper-node](https://github.com/ariym/whisper-node)

## Features

- Output transcripts to **JSON** (also .txt .srt .vtt)
- **Optimized for CPU** (Including Apple Silicon ARM)
- Timestamp precision to single word

## Installation

1. Add dependency to project

```text
npm install whisper-node-ts
```

2. Download whisper model of choice

```text
npx whisper-node-ts download
```

## Usage

```javascript
import whisper from "whisper-node-ts";

const transcript = await whisper("example/sample.wav");

console.log(transcript); // output: [ {start,end,speech} ]
```

### Output (JSON)

```javascript
[
  {
    start: "00:00:14.310", // time stamp begin
    end: "00:00:16.480", // time stamp end
    speech: "howdy" // transcription
  }
];
```

### Usage with Additional Options

```javascript
import whisper from 'whisper-node-ts';

const filePath = "example/sample.wav", // required

const options = {
  modelName: "tiny.en",                   // default
  modelPath: "/custom/path/to/model.bin", // use model in a custom directory
  whisperOptions: {
    gen_file_txt: false,      // outputs .txt file
    gen_file_subtitle: false, // outputs .srt file
    gen_file_vtt: false,      // outputs .vtt file
    timestamp_size: 10,       // amount of dialogue per timestamp pair
    word_timestamps: true     // timestamp for every word
  }
}

const transcript = await whisper(filePath, options);
```

## Made with

- [Whisper OpenAI (using C++ port by: ggerganov)](https://github.com/ggerganov/whisper.cpp)
- [ShellJS](https://www.npmjs.com/package/shelljs)

## Roadmap

- [x] Support projects not using Typescript
- [x] Allow custom directory for storing models
- [ ] Config files as alternative to model download cli
- [ ] Remove _path_, _shelljs_ and _prompt-sync_ package for browser, react-native expo, and webassembly compatibility
- [ ] [fluent-ffmpeg](https://www.npmjs.com/package/fluent-ffmpeg) to support more audio formats
- [ ] [Pyanote diarization](https://huggingface.co/pyannote/speaker-diarization) for speaker names
- [ ] [Implement WhisperX as optional alternative model](https://github.com/m-bain/whisperX) for diarization and higher precision timestamps (as alternative to C++ version)

## Modifying whisper-node-ts

`npm run dev` - runs nodemon and tsc on '/src/test.ts'

`npm run build` - runs tsc, outputs to '/dist' and gives sh permission to 'dist/download.js'

---
_Source: https://npm.io/package/whisper-node-ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._