Setting up VS Code
The CodeSandbox VS Code extension allows you to use VS Code to edit sandboxes and repositories on CodeSandbox.
This allows you to keep using your own extensions, keybindings and themes, while live collaborating with other people using CodeSandbox.
- If needed, install Visual Studio Code (opens in a new tab) for Windows (7+), macOS (10.11 +), or Linux.
- Download and install the CodeSandbox extension (opens in a new tab) for Visual Studio Code.
- Wait for the extension to finish downloading and then reload VS Code when prompted.
- Click on the CodeSandbox icon on the side menu and log in.
- Connect to your project.
When you connect to your CodeSandbox account and open a branch, a virtual container is spun up with Remote - SSH (opens in a new tab) to allow you to access your code. At the same time, a connection is established with a CodeSandbox API called Pitcher. This is the service that powers all of the collaboration features across different editors, including the web and mobile editors.
It is possible to work on the SSH connection while disconnected from Pitcher, but you should be mindful that other team members may be making changes to your branch while you are in an un-synced state, so be sure to commit often.
Only people on your CodeSandbox team have access to these repositories.
So the VS Code extension connects directly to the container with an SSH connection, bypassing Pitcher, where it operates directly with the FileSystem.
On top of this, we also connect to Pitcher, just like we do in the browser, where we "tie it together".
You can also open your work in Visual Studio Code Insiders (opens in a new tab) straight from the editor.
Once you open the branch, follow these steps:
- Click on the dropdown icon of the "Open in VS Code" button.
- In the dropdown menu, click on the "Open in VS Code Insiders" option.
- Open the command palette: MacOS: SHIFT+CMD+P; Windows: SHIFT+CTRL+P;
- Type "insiders" into the command palette prompt;
- Under the "Integrations" section, click on the "Open in VS Code Insiders" option.
CodeSandbox will remember your choice of IDE and will use it as the default button action next time you wish to open your project in Visual Studio Code.
You can reset your choice at any time by selecting a different option from the "Open in VS Code" dropdown menu.
To get the most out of VS Code, like automatic extension installation, we recommend you to follow these tips and tricks.