Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.24 KB

installation.md

File metadata and controls

72 lines (49 loc) · 2.24 KB
Raw

Table of Contents

Installation

Sage runs on Node.js, so you must have that installed, along with npm.

Note: These instructions are relevant as of July 28, 2015.

Google APIs

Sage uses Google APIs for speech-to-text conversion. This requires an API key.

To obtain an API key for the Google Speech API, follow these steps:

  1. Join the Chromium Dev Group on Google Groups. This unhides the Speech API in the developer console.
  2. Go to the Google Developers Console and create a project.
  3. In the sidebar on the left, click on "APIs & auth", then click on "APIs".
  4. Search for "Speech", and click on Speech API. Click on "Enable".
  5. Now you have access to the Speech API. To get your API key, click on "Credentials" under "APIs & auth".
  6. Create a public key.

Keep your API key handy for configuration.

Node.js Dependencies

Install this repo globally with NPM:

$ npm install -g ajay-gandhi/sage

This will install this repo and its Node.js dependencies.

The speakable module uses SoX to record audio (for speech to text conversion), so install sox:

$ sudo apt-get install sox # linux
$ brew install sox         # mac

The text-to-speech module uses the espeak executable, so install that as well:

$ sudo apt-get install espeak # linux
$ brew install espeak         # mac

All the required dependencies for Sage are now installed. Keep reading to add optional APIs (e.g. news), or see Usage to configure and run Sage.

Optional APIs

These APIs really increase the usability of Sage, since they add modules such as WolframAlpha.

WolframAlpha

Sign up for a WolframAlpha API key to take advantage of WolframAlpha's powerful knowledge engine. See Modules for usage.

  1. Go to WolframAlpha's developer page.
  2. Sign in or create an account.
  3. Go to "My Apps" at the top of the page, and choose "Get an AppID".
  4. Choose any name and description for you application, then continue.

Keep your API key handy for configuration.