From b80046120c9674d3c717dd426997606feeb52eb2 Mon Sep 17 00:00:00 2001
From: OpeOginni <107570612+OpeOginni@users.noreply.github.com>
Date: Sat, 23 Aug 2025 21:43:20 +0200
Subject: [PATCH] docs: document editor --wait flag (#2209)

Co-authored-by: rekram1-node <aidenpcline@gmail.com>
---
 packages/web/src/content/docs/docs/tui.mdx | 33 ++++++++++++++++------
 1 file changed, 24 insertions(+), 9 deletions(-)

diff --git a/packages/web/src/content/docs/docs/tui.mdx b/packages/web/src/content/docs/docs/tui.mdx
index e6ad1016..a886cd31 100644
--- a/packages/web/src/content/docs/docs/tui.mdx
+++ b/packages/web/src/content/docs/docs/tui.mdx
@@ -254,37 +254,52 @@ Both the `/editor` and `/export` commands use the editor specified in your `EDIT
 <Tabs>
   <TabItem label="Linux/macOS">
     ```bash
-    export EDITOR=nano # or vim, code, etc.
+    # Example for nano or vim
+    export EDITOR=nano
+    export EDITOR=vim
+
+    # For GUI editors (VS Code, Cursor, VSCodium, Windsurf, Zed, etc.) include --wait
+    export EDITOR="code --wait"
     ```
 
     To make it permanent, add this to your shell profile;
     `~/.bashrc`, `~/.zshrc`, etc.
-
   </TabItem>
+
   <TabItem label="Windows (CMD)">
     ```bash
-    set EDITOR=notepad # or code, vim, etc.
+    set EDITOR=notepad
+
+    # For GUI editors (VS Code, Cursor, VSCodium, Windsurf, Zed, etc.) include --wait
+    set EDITOR=code --wait
     ```
 
     To make it permanent, use **System Properties** > **Environment
     Variables**.
-
   </TabItem>
+
   <TabItem label="Windows (PowerShell)">
-    ```bash
-    $env:EDITOR = "notepad" # or "code", "vim", etc.
+    ```powershell
+    $env:EDITOR = "notepad"
+
+    # For GUI editors (VS Code, Cursor, VSCodium, Windsurf, Zed, etc.) include --wait
+    $env:EDITOR = "code --wait"
     ```
 
-    To make it permanent, add this to your PowerShell
-    profile.
-
+    To make it permanent, add this to your PowerShell profile.
   </TabItem>
 </Tabs>
 
 Popular editor options include:
 
 - `code` - Visual Studio Code
+- `cursor` - Cursor
+- `windsurf` - Windsurf
 - `vim` - Vim editor
 - `nano` - Nano editor
 - `notepad` - Windows Notepad
 - `subl` - Sublime Text
+
+:::tip
+Some editors need command-line arguments to run in blocking mode. The --wait flag makes the editor process block until closed, which is necessary for opencode to function correctly.
+:::