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.
After activation, Serenade can automatically install plugins for supported editors—Atom and VS Code. Make sure to restart your editor after the plugins are installed (to make sure the Serenade editor plugin is running), and you're ready to go!
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 Microphone.
Serenade floats above all your other windows, so you can keep it side-by-side with other applications, like your code 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 .
As you'll see, many Serenade commands take the same form: an action followed by a selector. An action is something you want to do to code, like a Reference section., , or . A selector is a block of code to operate on, like , , , or . To quickly reference common actions and selectors, check out the
Throughout the documentation, you'll see blocks that look like this:
- 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.
Serenade supports different commnads depending on which application is currently in the foreground (i.e., focused). At the bottom-left of the Serenade window, you can see which application is currently active, along with an icon indicating which commands are available. Here the various modes Serenade can be in:
Code editing mode
When your editor is in focus, and a file with a supported language is detected, all commands are available. Hover over the active app indicator to see the detected language.
When your editor is open to a file with a language that's not supported, a subset of commands are supported.
When your editor is not in focus, Serenade can still type raw text and run system commands.
|Command Category||Code editing mode||Text mode||Global mode|
|Navigating Code||Text selectors|
|Adding Code||Raw Text||Raw Text|
|Editing Code||Text selectors|
|Symbols and Formatting|
The automatic reminder can be turned off in "Settings > Editor > Active app reminder", and it will always be available when the active app indicator is hovered over.