From 967ce27566d9a79a8156615bf72a3ad9dbab7673 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Tue, 3 Feb 2026 15:22:31 +0000
Subject: [PATCH 1/2] Initial plan


From ea850804eccb986dd8f9794d8a0215b8906f2c5b Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Tue, 3 Feb 2026 15:25:17 +0000
Subject: [PATCH 2/2] docs: Add getting started instructions to Playwright
 Local Browser Server README

- Add instructions for starting the browser tunnel via Command Palette
- Document terminal.integrated.shellIntegration.enabled requirement
- Document autoStart setting for automatic tunnel startup

Co-authored-by: TheLarkInn <3408176+TheLarkInn@users.noreply.github.com>
---
 .../README.md                                 | 35 ++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/vscode-extensions/playwright-local-browser-server-vscode-extension/README.md b/vscode-extensions/playwright-local-browser-server-vscode-extension/README.md
index a6c8e029918..4968cb7f8ef 100644
--- a/vscode-extensions/playwright-local-browser-server-vscode-extension/README.md
+++ b/vscode-extensions/playwright-local-browser-server-vscode-extension/README.md
@@ -2,7 +2,40 @@
 
 Enables running Playwright tests in a remote VS Code environment (such as GitHub Codespaces) while launching and driving the actual browser process on your local machine.
 
-This extension is a UI wrapper around the tunneling/runtime library [`@rushstack/playwright-browser-tunnel`](../../apps/playwright-browser-tunnel). It starts/stops the local browser host process and forwards Playwright’s WebSocket traffic between the remote test runner and your local browser.
+This extension is a UI wrapper around the tunneling/runtime library [`@rushstack/playwright-browser-tunnel`](../../apps/playwright-browser-tunnel). It starts/stops the local browser host process and forwards Playwright's WebSocket traffic between the remote test runner and your local browser.
+
+## Getting Started
+
+Before running your Playwright tests in a remote environment, you must first start the browser tunnel:
+
+1. Open the VS Code **Command Palette** (`Ctrl+Shift+P` or `Cmd+Shift+P` on macOS)
+2. Search for and run **"Playwright: Start Playwright Browser Tunnel"**
+3. The tunnel will begin polling for connections from your remote environment
+4. Now you can run your Playwright tests in the remote workspace
+
+To stop the tunnel, open the Command Palette and run **"Playwright: Stop Playwright Browser Tunnel"**.
+
+### Requirements
+
+This extension requires VS Code's terminal shell integration to be enabled. Ensure the following setting is enabled in your VS Code settings:
+
+```json
+"terminal.integrated.shellIntegration.enabled": true
+```
+
+This is typically enabled by default, but if you have explicitly disabled it, the extension will not work correctly.
+
+### Auto-starting the tunnel
+
+If you want the browser tunnel to start automatically when VS Code opens, you can add the following to your workspace settings (`.vscode/settings.json`):
+
+```json
+{
+  "playwright-local-browser-server.autoStart": true
+}
+```
+
+> **Security note:** Auto-start is disabled by default because the tunnel allows a remote environment to launch browser processes on your local machine. Only enable auto-start for workspaces you trust.
 
 ## How it works