Skip to content

Commit 31a4ec7

Browse files
committed
docs: Update shell integration settings section for clarity and consistency
1 parent 006fbcb commit 31a4ec7

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/features/shell-integration.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,31 +73,31 @@ Enable this if terminal commands aren't working correctly or you see 'Shell Inte
7373

7474
The following settings are applicable when "Disable terminal shell integration" is **unchecked** (i.e., shell integration is enabled):
7575

76-
##### a. Terminal shell integration timeout
76+
##### Terminal shell integration timeout
7777
<img src="/img/shell-integration/shell-integration-1.png" alt="Terminal shell integration timeout slider set to 15s" width="600" />
7878
Maximum time to wait for shell integration to initialize before executing commands. For users with long shell startup times, this value may need to be increased if you see 'Shell Integration Unavailable' errors in the terminal. Default: 15s (as shown in UI).
7979

80-
##### b. Terminal command delay
80+
##### Terminal command delay
8181
<img src="/img/shell-integration/shell-integration-2.png" alt="Terminal command delay slider set to 0ms" width="600" />
8282
Delay in milliseconds to add after command execution. The default setting of 0 disables the delay completely. This can help ensure command output is fully captured in terminals with timing issues. In most terminals, it is implemented by setting `PROMPT_COMMAND='sleep N'` and Powershell appends `start-sleep` to the end of each command. Originally was workaround for VSCode bug [#237208](https://github.com/microsoft/vscode/issues/237208) and may not be needed. Default: 0ms.
8383

84-
##### c. Enable PowerShell counter workaround
84+
##### Enable PowerShell counter workaround
8585
<img src="/img/shell-integration/shell-integration-3.png" alt="Enable PowerShell counter workaround checkbox" width="600" />
8686
When enabled, adds a counter to PowerShell commands to ensure proper command execution. This helps with PowerShell terminals that might have issues with command output capture.
8787

88-
##### d. Clear ZSH EOL mark
88+
##### Clear ZSH EOL mark
8989
<img src="/img/shell-integration/shell-integration-4.png" alt="Clear ZSH EOL mark checkbox" width="600" />
9090
When enabled, clears the ZSH end-of-line mark by setting `PROMPT_EOL_MARK=''`. This prevents issues with command output interpretation when output ends with special characters like '%'.
9191

92-
##### e. Enable Oh My Zsh integration
92+
##### Enable Oh My Zsh integration
9393
<img src="/img/shell-integration/shell-integration-5.png" alt="Enable Oh My Zsh integration checkbox" width="600" />
9494
When enabled, sets `ITERM_SHELL_INTEGRATION_INSTALLED=Yes` to enable Oh My Zsh shell integration features. Applying this setting might require restarting the IDE.
9595

96-
##### f. Enable Powerlevel10k integration
96+
##### Enable Powerlevel10k integration
9797
<img src="/img/shell-integration/shell-integration-6.png" alt="Enable Powerlevel10k integration checkbox" width="600" />
9898
When enabled, sets `POWERLEVEL9K_TERM_SHELL_INTEGRATION=true` to enable Powerlevel10k shell integration features.
9999

100-
##### g. Enable ZDOTDIR handling
100+
##### Enable ZDOTDIR handling
101101
<img src="/img/shell-integration/shell-integration-7.png" alt="Enable ZDOTDIR handling checkbox" width="600" />
102102
When enabled, creates a temporary directory for ZDOTDIR to handle zsh shell integration properly. This ensures VSCode shell integration works correctly with zsh while preserving your zsh configuration.
103103

0 commit comments

Comments
 (0)