docs: add Cygwin terminal configuration for Windows users#225
docs: add Cygwin terminal configuration for Windows users#225hannesrudolph merged 9 commits intoRooCodeInc:mainfrom
Conversation
Add comprehensive shell integration documentation with: - Detailed explanation of how shell integration works - Installation and troubleshooting instructions - Known issues and solutions - Update FAQ to link to shell integration guide - Add shell integration to sidebar navigation Signed-off-by: Eric Wheeler <roo-code@z.ewheeler.org>
Add detailed instructions for configuring Cygwin as a terminal in VS Code for Windows users: - Installation steps for Cygwin - VS Code settings.json configuration with explanation of parameters - Instructions for setting Cygwin as the default terminal - Guidance on opening Cygwin terminals - Note about shell integration compatibility This helps Windows users who prefer Cygwin's Unix-like environment to properly configure it with shell integration support. Signed-off-by: Eric Wheeler <roo-code@z.ewheeler.org>
|
Someone is attempting to deploy a commit to the Roo Code Team on Vercel. A member of the Team first needs to authorize it. |
|
cc: @hannesrudolph |
|
@hannesrudolph this PR is broken, can you add this somewhere in the shell integration section? ### Cygwin (bash, zsh)
Cygwin provides a Unix-like environment on Windows systems. To configure Cygwin as your terminal in VS Code:
1. Install Cygwin from [https://www.cygwin.com/](https://www.cygwin.com/)
2. Open VS Code settings:
- Select File > Preferences > Settings
- Click the "Open Settings (JSON)" icon in the top right corner
3. Add the following configuration to your `settings.json` (inside the top-level curly braces `{}`):
```json
{
"terminal.integrated.profiles.windows": {
"Cygwin": {
"path": "C:\\cygwin64\\bin\\bash.exe",
"args": ["--login"],
"env": {"CHERE_INVOKING": "1"}
}
},
"terminal.integrated.defaultProfile.windows": "Cygwin"
}
```
> Note: If you have 32-bit Cygwin installed, use `"C:\\cygwin\\bin\\bash.exe"` for the path.
4. Understanding the configuration:
- `path`: Points to the Bash executable in your Cygwin installation
- `args`: The `--login` flag ensures the shell reads profile files
- `env`: The `CHERE_INVOKING` environment variable tells Cygwin to use the current directory as the working directory
- `terminal.integrated.defaultProfile.windows`: Sets Cygwin as the default terminal profile
5. To open a new Cygwin terminal:
- Press Ctrl+Shift+(backtick) to open a new terminal, or
- Press `F1`, type "Terminal: Create New Terminal (with Profile)", and select "Cygwin"
While our testing shows that this works out of the box, if you encounter shell integration issues with Cygwin, ensure you have added the appropriate shell integration hooks to your Cygwin bash profile as described in the "Manual Shell Integration Installation" section. |
|
thank you just make sure it does what you want because it looks like some of the files may have moved around since I pushed this |
|
yeah i was looking at that |
|
ok @KJ7LNW is that proper now? |
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the shell integration guide by adding instructions for configuring Cygwin as a terminal in VS Code on Windows, and refines existing troubleshooting sections.
- Introduces a new “Cygwin (bash, zsh)” section with installation steps and
settings.jsonconfiguration. - Explains how to set Cygwin as the default terminal and open new Cygwin shells.
- Updates the command chaining example under Known Issues for proper encoding.
Comments suppressed due to low confidence (1)
docs/features/shell-integration.md:421
- Using
&&inside backticks will render as literal&&instead of&&. Replace with backtick-escaped&&without HTML escaping to display the intended operator.
**Workaround**: Instead of multi-line commands, use command chaining with `&&` to keep everything on one line (e.g., `echo a && echo b` instead of typing each command on a separate line).
KJ7LNW
left a comment
There was a problem hiding this comment.
Other than that missing header it looks great. Thank you for cleaning that up!
|
|
||
| --- | ||
|
|
||
| ## Known Issues and Workarounds |
There was a problem hiding this comment.
I think you want to keep this header:
---
## Known Issues and Workarounds
Context
This PR adds documentation for configuring Cygwin as a terminal in VS Code for Windows users in the shell integration guide.
Implementation
The implementation adds a new section under 'Additional Troubleshooting for Windows Users' that includes:
This helps Windows users who prefer Cygwin's Unix-like environment to properly configure it with shell integration support.
How to Test
Get in Touch
Discord: KJ7LNW
Important
Adds Cygwin terminal configuration for Windows users in
shell-integration.md, including installation and setup instructions.shell-integration.mdfor Windows users.settings.jsonconfiguration, and setting Cygwin as default terminal.This description was created by
for 49a8cb4. You can customize this summary. It will automatically update as commits are pushed.