Skip to content

Commit 9f80bb0

Browse files
author
Eric Wheeler
committed
docs: add getting started section to shell integration guide
Reorganize shell integration documentation to provide quick setup steps at the top: - Add Getting Started section before technical details - Include quick setup steps for all users, Windows, and WSL - Improve WSL instructions with clearer method descriptions - Add note about shell integration timeout with large rc files Signed-off-by: Eric Wheeler <[email protected]>
1 parent 0e2587f commit 9f80bb0

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/troubleshooting/shell-integration.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,40 @@
44

55
Shell integration is a [new feature in VSCode 1.93](https://code.visualstudio.com/updates/v1_93#_terminal-shell-integration-api) that allows extensions like Roo Code to run commands in your terminal and read their output. Command output allows Roo Code to react to the result of the command on its own, without you having to handhold by copy-pasting the output in yourself. It's also quite powerful when running development servers as it allows Roo Code to fix errors as the server logs them.
66

7+
## Getting Started with Shell Integration
8+
9+
If you're seeing "Shell Integration Unavailable" messages or Roo Code can't see command output, follow these quick steps:
10+
11+
### For All Users
12+
13+
1. **Update VSCode/Cursor** to the latest version
14+
2. **Select a supported shell**: Open Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) → "Terminal: Select Default Profile" → Choose bash, zsh, PowerShell, or fish
15+
3. **Restart VSCode** completely
16+
17+
### For Windows Users
18+
19+
**PowerShell users**: Set execution policy to RemoteSigned:
20+
```powershell
21+
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
22+
```
23+
24+
### For WSL Users
25+
26+
1. **Running VSCode From _Inside_ WSL**: Run `code .` or `code-insiders .` from your WSL terminal
27+
2. **Running VSCode From Windows with WSL Terminal**: Install WSL extension and add to your `~/.bashrc`:
28+
```bash
29+
. "$(code --locate-shell-integration-path bash)"
30+
```
31+
or
32+
```bash
33+
. "$(code-insiders --locate-shell-integration-path bash)"
34+
```
35+
36+
Notice: if you have a very large `.bash_profile` or `.bashrc` then you might want to put the code/code-insiders script sourcing toward the top so that shell integration does not time out.
37+
38+
If you're still having issues after these steps, see the detailed troubleshooting sections below.
39+
40+
741
## How Shell Integration Works
842

943
Shell integration uses special terminal sequences (like ANSI escape codes) to mark different stages of command execution in your terminal. Here's how it works:

0 commit comments

Comments
 (0)