Skip to content

Commit cf3b526

Browse files
committed
docs(shell-integration): update Fish+Cygwin setup instructions
Fix grammar errors
1 parent 0955e9c commit cf3b526

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/features/shell-integration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ For optimal shell integration with WSL, we recommend:
230230

231231
### VS Code Shell Integration for Fish + Cygwin on Windows
232232

233-
For fellow Windows users running Fish terminal within a Cygwin environment, here's how VS Code's shell integration working:
233+
For fellow Windows users running Fish terminal within a Cygwin environment, here's how VS Code's shell integration works:
234234

235235
1. **Locate the Shell Integration Script:**
236236
Open your Fish terminal *within VS Code* and run the following command:
@@ -277,29 +277,29 @@ For fellow Windows users running Fish terminal within a Cygwin environment, here
277277
"icon": "terminal-bash" // Optional: Use a recognizable icon
278278
}
279279
// Alternative (if the above fails): Launch fish directly
280-
"fish": {
280+
"fish-direct": {
281281
"path": "C:\\cygwin64\\bin\\fish.exe", // Ensure this is in your Windows PATH or provide full path
282-
// It doesn't use 'args' but 'options' instead. Or you will get error terminal process terminated exit code 1
282+
// Use 'options' here instead of 'args'; otherwise, you might encounter the error "terminal process terminated exit code 1".
283283
"options": ["-l", "-c"], // Example: login and interactive flags.
284284
"icon": "terminal-fish" // Optional: Use a fish icon
285285
}
286286
},
287287
288288
// Optional: Set fish as your default if desired
289-
// "terminal.integrated.defaultProfile.windows": "fish",
289+
// "terminal.integrated.defaultProfile.windows": "fish", // or "fish-direct" depending what you use.
290290
291291
// ... other settings ...
292292
}
293293
```
294-
*Note: Using `bash.exe --login -i -c "exec fish"` is often more reliable in Cygwin environments for ensuring the correct environment setup before `fish` starts. But if it doesn't work for you, try the second option to use fish directly*
294+
*Note: Using `bash.exe --login -i -c "exec fish"` is often more reliable in Cygwin environments for ensuring the correct environment setup before `fish` starts. However, if that approach doesn't work, try the `fish-direct` profile configuration.*
295295
296296
4. **Restart VS Code:**
297297
Close and reopen Visual Studio Code completely to apply the changes.
298298
299299
5. **Verify:**
300300
Open a new Fish terminal in VS Code. The shell integration features (like command decorations, better command history navigation, etc.) should now be active. You can test basic functionality by running simple commands like `echo "Hello from integrated Fish!"`. <img src="/img/shell-integration/shell-integration-8.png" alt="Fish Cygwin Integration Example" width="600" />
301301
302-
This setup works reliably on my Windows system using Cygwin, Fish, and Starship prompt. Hope this helps others with similar configurations!
302+
This setup works reliably on Windows systems using Cygwin, Fish, and the Starship prompt, and should assist users with similar configurations.
303303
304304
305305
### Shell Integration Failures After VSCode 1.98

0 commit comments

Comments
 (0)