Welcome to the Serenade docs! Here, you'll find an overview of everything Serenade can do, along with examples. First, let's get Serenade installed on your device.
First, download and install Serenade. Serenade supports macOS, Windows, and Linux—platform-specific installation instructions can be found on the download page.
After installing Serenade, you'll be prompted to activate the app via an email link. If that link doesn't work, you can use the code provided on the activation page to activate manually.
The Serenade application will help you install the extension from the Chrome Web Store.
You can use Serenade with your laptop microphone, though we recommend using a headset for the best accuracy. You can verify that a headset is being used by clicking , and then Settings.
Serenade floats above all your other windows, so you can keep it side-by-side with your editor. You can toggle Serenade by clicking the Listening switch or pressing Alt+Space. Then, as you speak, you'll see a list of transcripts in the Serenade window.
Sometimes, Serenade isn't sure what you said, so you'll see a few different options. The first one will be used automatically, but to use a different option (and undo the first one), just say the number you want to use instead. For instance, to use the second option, just say. If none of the options are right, you can just say .
Throughout the documentation, you'll see blocks that look like this:
Each block shows the syntax for the voice command followed by several examples. To change the programming language used in the examples, use the language switcher in the navigation bar.
- Text in
<angle brackets>is free-form text, like the name of a function or variable.
- Text separated by pipes, like
(foo | bar), represents a list of choices (i.e., an or).
- Text in
[square brackets]is optional.