GitHub Copilot Voice

Write code without the keyboard.
Difficulty typing? Use your voice to code without spelling things out by talking with GitHub Copilot.
Explore the docs »

Homepage · Discord

About The Project

'GitHub Copilot Voice' is a voice assistant to interact with VS Code. It is primarily targeted toward developers that have difficulty using the keyboard and mouse.

With GitHub Copilot Voice, developers can use their voice to harness the power of Copilot to write code collaboratively. In addition, GitHub Copilot Voice also helps with interacting with the VS Code UI. GitHub Copilot Voice can be used to perform a variety of tasks, such as opening files, running commands, and navigating the editor.

No more remembering a ton of keybindings or very specific and strange voice incantations. GitHub Copilot Voice is here to help you with all of that. Simply say "Copilot" to get started.

Subscription

As an early technical preview, we are operating a waitlist for GitHub Copilot Voice. If you think you could benefit from it, sign up here.

GitHub Copilot Voice also requires a GitHub Copilot subscription. GitHub Copilot is free for verified students and maintainers of popular open source projects on GitHub.

Pre-requisites

1. To use GitHub Copilot Voice, you must log into your GitHub account to ensure you have access to GitHub Copilot.

2. You also need to install Java (>= Java 11, if not already present): https://learn.microsoft.com/en-us/java/openjdk/download

3. GitHub Copilot Voice will use the default system microphone.

4. On Linux, you will need 'sox' installed to provide the 'play' command to hear notification sounds.

5. If you also have the GitHub Copilot extension installed, you should disable it while using GitHub Copilot Voice.

Troubleshooting

We’d love to get your help in making 'GitHub Copilot Voice' better! If you have feedback or encounter any problems, please reach out on our Discord.

Getting Started

Explore more detailed documentation here.

GitHub Copilot Voice provides voice-first UX to control VScode and make GitHub copilot accessible to even more developers. The simplest way of getting started is to say, Copilot followed by a command. For example, we can say things like, "Copilot, toggle sidebar." This will cause the sidebar to open or close.

We understand that using the hot word over and over again can get old pretty soon, especially when developers are in the zone for building software. So we made a special "active mode" just to avoid tongue fatigue. In active mode, developers do not have to say, "Copilot" to activate the speech-to-text service. The extension continuously listens and responds appropriately to the commands. To activate the active mode, developers can say, "Copilot, start active mode." To deactivate the active mode, developers can say, "stop active mode."

Sample IDE Control commands

These commands help with IDE interactions. Here are a few examples of these commands

• "toggle sidebar" -> toggles the sidebar
• "goto line 56" -> moves the cursor to line 56
• "toggle zen mode" -> toggles zen mode
• "run code" -> run code in terminal
• "save" -> save the current file
• "save all" -> saves all open files
• "undo" -> undo the last action
• "redo" -> redo the last action
• "clear console" -> clears the terminal
• "zoom" -> zooms in
• "zoom out" -> zooms out
• "pause mic" -> pauses the listening
• "goto end" -> moves the cursor to the end of the file
• "go to the end of line number 28" -> takes cursor to the end of line 28 in the active editor window (if open)
• "insert a new line at line number 12" -> takes cursor to line 12 and then adds a newline (within active editor window)
• "select line 43" -> selects line 43
• "select lines 5 to 10" -> selects lines 5 to 10
• "delete line 15" -> deletes line 15
• "delete lines 4 to 16" -> deletes lines 4 to 16
• "delete lines 10 to the end" -> deletes lines starting from 4 till the end of file
• "go to next class" -> moves the cursor to the next class
• "select previous function" -> selects the previous function
• "select current symbol" -> selects the current symbol = "select function set Collection" -> tries to find and select the function setCollection

We have over 300 uniquely identifiable commands in this category and we are constantly adding more.

Sample Code Generation/Editing

These commands help with writing code:

• "write code to print the gcd of 2 numbers" -> generates a code suggestion. Try to be as specific as possible with what you want.
• "change the return type of the function to a boolean" -> edits the suggested code currently displayed in "ghost text"
• "explain the code" -> explains a manually selected range of line(s), playing the response as an audio interaction
• "explain lines 4 to 7" -> explains the range of lines specified

License

By downloading and using the 'GitHub Copilot Voice' extension and its related components, you agree to our license terms.