Connecting to a Remote Pieces OS Instance

Through multiple user support tickets, we have noticed that many of our users are using the Pieces for Developers VS Code extension in a remote development environment.

This guide will walk you through how to connect to a remote Pieces OS instance using the Pieces for Developers VS Code extension.

• This is currently only available for the Pieces for Developers VS Code extension. Functionality for the rest of the Pieces for Developers ecosystem is coming soon.

Use Cases#

• GitHub Codespaces
• Windows Subsystem for Linux (WSL)
• SSH connection
• Development Containers

Prerequisites#

• 1 machine with Pieces OS installed
• 1 machine with the Pieces for Developers VS Code extension installed
• ngrok installed on the machine with Pieces OS

Setting up your ngrok tunnel#

We recommend using a static ngrok URL which you can claim by following this guide.

Setting up your Pieces VS Code extension#

Now we will set up your Pieces VS Code extension to connect to your machine with Pieces OS.

1. Open VS Code on your machine
2. Go to VS Code Settings CMD/CTRL + ,
3. Ensure that you have the Workspace tab selected
4. Search pieces custom url
5. Paste your ngrok forwarding URL in the input for Pieces: Custom Url

Reloading your VS Code window#

Now we will reload your VS Code window to ensure that your Pieces VS Code extension is using your ngrok forwarding URL.

1. Open up the Command Palette CMD/CTRL + Shift + P
2. Search Reload Window
3. Select Developer: Reload Window