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.
Serenade is freely available for macOS, Windows, and Linux. To download Serenade, head to https://serenade.ai/download.
After installation, Serenade will walk you through installing plugins for supported applications, like VS Code, Chrome, and Hyper. Serenade will then guide you through interactive tutorials to practice voice coding.
By default, Serenade uses a cloud-based speech-to-code system. To run Serenade entirely on your device, so no data leaves your computer, check out Serenade Pro.
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 throughout these docs, most Serenade voice commands have the same form:
action is something you want to do to your code. Common actions include to add a new line of code, to edit code, and to remove code.
selector is a block of code to operate on. Some selectors are text-based, like or . Even more powerful selectors are code-based, which enable you to reference parts of your code, including , , and . For a complete list of selectors, see the Reference section.
Serenade commands simply combine an action and a selector:, , and .
You can also chain commands together without pausing. For instance, you can sayto save your current file and then focus your terminal, or to add a new method at the start of a class.
Finally, you can also specify how many times a command should be executed. For instancewill run the indent command three times.
Serenade has a few different configurable modes to change how your voice commands are interpreted.
Serenade's default mode is Command Mode. In this mode, if you say something that isn't a valid Serenade command, Serenade will show an x next to the command and won't do anything. To enable command mode, just say.
Sometimes, like when inserting a longer block of text, you want Serenade to simply insert everything you're saying, regardless of whether or not it's a valid command. Serenade's Insert Mode does just that. To enable it, just say, and then Serenade will insert everything you say. Some commands, like , , and , will also be presented as alternatives so you don't have to leave dictate mode to use them.
By default, Serenade will auto-detect which programming language is being used based on your editor's filename or active language setting. Sometimes, you might want to override this behavior and specify which language Serenade should use. To do so, simply say, , and so on. To get re-enable auto-detection, say .