Snosay NPM | npm.io

snosay

A cli wrapper for say - npm, crossplatform TTS (Text To Speech) Module for Node.js

Usage Examples

npx -y -- snosay --list
# Microsoft David Desktop
# Microsoft Zira Desktop

npx -y -- snosay hello, world
npx -y -- snosay --voice "Microsoft David Desktop" --speed 0.5 hello, world
npx -y -- snosay --voice "Microsoft Zira Desktop" --speed 1.5 hello, world
npx -y -- snosay --voice "Microsoft Zira Desktop" --speed 1.5 --output ./hello-world.mp3 hello, world

# or install as global package
npm i -g snosay

snosay --list
snosay --voice "Microsoft David Desktop" --speed 0.5 hello, world
snosay --voice "Microsoft Zira Desktop" --speed 1.5 hello, world
snosay --voice "Microsoft Zira Desktop" --speed 1.5 --output ./hello-world.mp3 hello, world

# or use stdin
echo hello, world | snosay

# or use REPL mode

# snosay - REPL Mode: speak the lines you just type.
# try type anything and press enter
snosay

# try type anything and press enter
snosay -v "Microsoft Zira Desktop"

# speak texts from your clipboard, (Note: paste is a windows command)
paste | snosay

# congratulate when build done, and oops when the build fail
npm run build && snosay congratulate your built is success!! || snosay oh no the build fails

# you can kill the process if you need to stop saying

Import as Library

import { speak } from "snosay";
await speak("test passed", undefined, 2);

API

export declare const speak: (
  text: string,
  voice?: string | undefined,
  speed?: number | undefined,
) => Promise<void>;
export declare const stop: () => Promise<void>;
export declare const getInstalledVoices: () => Promise<string[]>;
export declare const exportFile: (
  text: string,
  voice?: string | undefined,
  speed?: number | undefined,
  filePath?: string | undefined,
) => Promise<void>;