Skip to content

Commit bc8a1ea

Browse files
committed
document zsh completion workaround for msys2/Windows
Add note explaining that zsh users on Windows/msys2 need to pipe through 'tr -d \r' to strip carriage returns and avoid parse errors when setting up command-line completion.
1 parent 00dec75 commit bc8a1ea

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

  • docs/automate/cmemc-command-line-interface/configuration/completion-setup

docs/automate/cmemc-command-line-interface/configuration/completion-setup/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ In order to enable tab completion with **zsh** run the following command:
3333
$ eval "$(_CMEMC_COMPLETE=zsh_source cmemc)"
3434
```
3535

36+
!!! note "Windows / msys2"
37+
38+
When using zsh on Windows with msys2, you need to strip carriage returns to avoid parse errors:
39+
40+
``` shell-session title="completion setup for zsh on Windows/msys2"
41+
$ eval "$(_CMEMC_COMPLETE=zsh_source cmemc | tr -d '\r')"
42+
```
43+
3644
To enable the interactive menu as seen above in **zsh** run the following command:
3745

3846
``` shell-session title="interactive menu for zsh"

0 commit comments

Comments
 (0)