Portal VSCode Extension
Expose your local service to the internet via a Portal relay tunnel, directly from VSCode.
Features
Portal: Start Tunnel prompts only for the local host:port, then starts the tunnel with configured relay URLs or the default public registry
Portal: Start Tunnel (Advanced) prompts for host, optional service name, relay source, and optional thumbnail
Portal: Stop Tunnel stops the active tunnel terminal
- Persisted settings for relay URLs, default local host, and default service name
- Uses the installed Portal binary path after running the installer, so first-run install + expose works in one terminal
- When no relay URL is configured, the extension can use the public registry at
https://raw.githubusercontent.com/gosuda/portal/main/registry.json
Requirements
Settings
| Setting |
Default |
Description |
portal.relayUrls |
[] |
Relay server URLs (https:// only). If empty, the extension uses https://raw.githubusercontent.com/gosuda/portal/main/registry.json. |
portal.defaultHost |
"localhost:3000" |
Default local host:port shown by Portal: Start Tunnel. |
portal.defaultName |
"" |
Default tunnel service name suggestion. If empty, the advanced prompt starts blank. |
Example settings.json:
{
"portal.relayUrls": ["https://my-relay.example.com"],
"portal.defaultHost": "localhost:3000",
"portal.defaultName": "my-app"
}
Usage
- Open Command Palette (
Cmd+Shift+P / Ctrl+Shift+P)
- Run
Portal: Start Tunnel
- Enter the local host:port you want to expose
- The tunnel starts in the integrated terminal
Use Portal: Start Tunnel (Advanced) when you need a different host, custom relay selection, or a thumbnail URL.
To stop, run Portal: Stop Tunnel or close the Portal Tunnel terminal.
Development
git clone https://github.com/gosuda/portal
cd portal/extensions/vscode
corepack pnpm install --frozen-lockfile
Open the folder in VSCode, then press F5 to launch the Extension Development Host.
To test the extension locally:
- Open
extensions/vscode in VSCode.
- Press
F5 and choose Run Extension.
- In the new Extension Development Host window, run
Portal: Start Tunnel or Portal: Start Tunnel (Advanced) from the Command Palette.
If you want Linux behavior from WSL, open the folder with Remote - WSL first so the extension host runs in WSL instead of Windows.
Release Notes
0.0.2
- Enforce
https:// relay URLs
- Prompt only for the local host in
Portal: Start Tunnel
- Add
Portal: Start Tunnel (Advanced) for host, name, relay, and thumbnail overrides
- Allow empty service names so the CLI can auto-generate them
- Use the installed Portal binary path after installer execution