https://github.com/jacoblincool/vosk-cli
Use vosk in command line. List all pre-trained models, download & install them, and use them to transcribe audio files or live audio.
https://github.com/jacoblincool/vosk-cli
speech-recognition vosk
Last synced: 3 months ago
JSON representation
Use vosk in command line. List all pre-trained models, download & install them, and use them to transcribe audio files or live audio.
- Host: GitHub
- URL: https://github.com/jacoblincool/vosk-cli
- Owner: JacobLinCool
- License: mit
- Created: 2022-09-08T06:01:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T20:24:32.000Z (almost 2 years ago)
- Last Synced: 2025-03-18T21:36:46.560Z (7 months ago)
- Topics: speech-recognition, vosk
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/vosk-cli
- Size: 58.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vosk CLI
Use vosk in command line.
List all pre-trained models, download & install them, and use them to transcribe audio files or live audio.
```sh
❯ vosk help
Usage: vosk [options] [command]
Use vosk in command line.
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
list|ls List all the models available
install|i [options] Install a model
remove|rm Remove a model
recognize|rec [options] Recognize text from an audio file
microphone|mic [options] Recognize text from microphone
help [command] display help for command
```
## Usage
### Install Model
```sh
# Install the small english model
❯ vosk i english
```
```sh
# Install the large english model
❯ vosk i en-us-0.22
```
```sh
# Install from a local file
❯ vosk i --from "path/to/my-model.zip" my-model-name
```
> Tips: you can use `vosk ls` to list all the official models, and `vosk-model-` prefix is optional.
### Using Microphone
```sh
# Using the small english model to recognize text from microphone and output the result to a file (with live preview)
❯ vosk mic -o out.txt -t english
# Output:
ℹ hello
ℹ my name is jacob
⠇ Listening
```
### Using Audio File
```sh
# Using the small english model to recognize text from an audio file (auto-convert to wav), and output the result to stdout
❯ vosk rec -c english audio.mp3
```