# @cityssm/whisper-speech-to-text

> Locally converts recorded audio, like WAV files and MP3s, to text using OpenAI Whisper.

Latest version **0.2.2** (published 2026-09-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cityssm/whisper-speech-to-text
pnpm add @cityssm/whisper-speech-to-text
yarn add @cityssm/whisper-speech-to-text
bun add @cityssm/whisper-speech-to-text
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2026-09-23 |
| First published | 2026-05-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 18.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | The Corporation of the City of Sault Ste. Marie |
| Maintainers | dgowans |
| Keywords | openai, whisper, speech-to-text |

## Links

- npm: https://www.npmjs.com/package/@cityssm/whisper-speech-to-text
- Repository: https://github.com/cityssm/node-whisper-speech-to-text
- Homepage: https://github.com/cityssm/node-whisper-speech-to-text#readme
- Issues: https://github.com/cityssm/node-whisper-speech-to-text/issues
- npm.io page: https://npm.io/package/@cityssm/whisper-speech-to-text

## Dependencies (1)

- [debug](https://npm.io/package/debug.md) ^4.4.3

## Recent versions

- 0.2.2 (latest) — 2026-09-23
- 0.2.1 — 2026-05-26
- 0.2.0 — 2026-05-26
- 0.1.1 — 2026-05-25
- 0.1.0 — 2026-05-22

## README

# OpenAI Whisper for Node

[![DeepSource](https://app.deepsource.com/gh/cityssm/node-whisper-speech-to-text.svg/?label=active+issues&show_trend=true&token=5bcKTrYXN2Yhxo2JumotW1BK)](https://app.deepsource.com/gh/cityssm/node-whisper-speech-to-text/)
[![codecov](https://codecov.io/gh/cityssm/node-whisper-speech-to-text/graph/badge.svg?token=DQW707DSN9)](https://codecov.io/gh/cityssm/node-whisper-speech-to-text)

**Locally converts recorded audio, like WAV files and MP3s, to text using OpenAI Whisper.**

## Prerequisites

Like other Node wrappers around OpenAI Whisper,
this package requires a few tools to work.

### Python

Download from the [official Python website](https://www.python.org/).
For best results, make sure to add Python to the path.

### FFmpeg

For audio processing.

On Windows via Chocolatey:

```cmd
choco install ffmpeg
```

On Debian-based Linux:

```bash
sudo apt-get install ffmpeg
```

### OpenAI Whisper

Probably the easiest way to install Whisper is using the Python package manager,
`pip`.

```cmd
pip install -U openai-whisper
```

To test your installation:

```cmd
whisper --help
```

## Installation

```bash
npm install @cityssm/whisper-speech-to-text
```

## Usage

```javascript
import speechToText from '@cityssm/whisper-speech-to-text'

const basicTranscription = await speechToText('path/to/audioFile.mp3')

const transcriptionWithOptions = await speechToText('path/to/audioFile.wav', {
  whisperPath: 'path/to/whisper',
  model: 'large',
  language: 'en'
})
```

---
_Source: https://npm.io/package/@cityssm/whisper-speech-to-text · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._