RESTful wrapper around say.js. Runs on Mac OS X. Useful for text-to-speech notifications in a continuous integration environment.
Install the module with:
npm install sayeasy
var sayeasy = require('sayeasy'); sayeasy.start();
Command Line Interface (CLI)
sayeasy comes with a easy-to-use CLI tool that sends text to a sayeasy server.
If you run
npm install -g sayeasy the sayeasy CLI will be available in your
To speak "Hello World!" using the Cellos voice on
sh $ sayeasy Hello World! -v Cellos
Want to run the sayeasy command on a different server/port than
localhost:4000, set these environment variables:
sh $ export SAYEASY_SERVER=10.10.10.10 sh $ export SAYEASY_PORT=3003
/speak is a endpoint that accepts an HTTP
POST request with three parameters:
- voice - The Mac OS X voice to speak the text. (optional, default: 'Bruce')
- text - The text to speak. (required)
- sound - The name of an *.mp3 file in
/levels is a HTTP
POST endpoint that sets the system volume.
- volume - A number [0-10] that sets the system volume. 0 is mute and 10 is the highest.
/sounds is an endpoint that accepts an HTTP
GET request to return a JSON array of *.mp3 files sayeasy can play. The directory sayeasy uses to look for *.mp3 files is configured in the
SOUND_DIRECTORY environment variable (default:
afplay processes on the system.
sh $ curl -dtext='Hello World' -dvoice=Bruce http://localhost:4000/speak
0.1.2 - Include CLI Tool
0.1.0 - Initial Release
Copyright (c) 2012 Clay Smith
Licensed under the MIT license.