Skip to content

docs: add Cygwin terminal configuration for Windows users#225

Merged
hannesrudolph merged 9 commits intoRooCodeInc:mainfrom
KJ7LNW:cygwin-shell-integration-docs
Jun 19, 2025
Merged

docs: add Cygwin terminal configuration for Windows users#225
hannesrudolph merged 9 commits intoRooCodeInc:mainfrom
KJ7LNW:cygwin-shell-integration-docs

Conversation

@KJ7LNW
Copy link
Contributor

@KJ7LNW KJ7LNW commented Jun 6, 2025

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:

  • 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.

How to Test

  1. Review the added documentation in docs/shell-integration.md
  2. Verify the instructions are clear and accurate
  3. If possible, test the configuration on a Windows system with Cygwin installed

Get in Touch

Discord: KJ7LNW


Important

Adds Cygwin terminal configuration for Windows users in shell-integration.md, including installation and setup instructions.

  • Documentation:
    • Adds Cygwin configuration section to shell-integration.md for Windows users.
    • Includes installation steps, settings.json configuration, and setting Cygwin as default terminal.
    • Provides guidance on opening Cygwin terminals and notes on shell integration compatibility.

This description was created by Ellipsis for 49a8cb4. You can customize this summary. It will automatically update as commits are pushed.

Eric Wheeler added 2 commits March 8, 2025 17:08
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>
@vercel
Copy link

vercel bot commented Jun 6, 2025

Someone is attempting to deploy a commit to the Roo Code Team on Vercel.

A member of the Team first needs to authorize it.

@daniel-lxs
Copy link
Member

cc: @hannesrudolph

@daniel-lxs daniel-lxs moved this from Triage to PR [Draft / In Progress] in Roo Code Roadmap Jun 7, 2025
@KJ7LNW
Copy link
Contributor Author

KJ7LNW commented Jun 18, 2025

@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.

@KJ7LNW KJ7LNW marked this pull request as draft June 18, 2025 23:44
@KJ7LNW
Copy link
Contributor Author

KJ7LNW commented Jun 18, 2025

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

@hannesrudolph
Copy link
Collaborator

yeah i was looking at that

@hannesrudolph
Copy link
Collaborator

ok @KJ7LNW is that proper now?

@hannesrudolph hannesrudolph marked this pull request as ready for review June 18, 2025 23:57
Copilot AI review requested due to automatic review settings June 18, 2025 23:57
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.json configuration.
  • 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 &amp;&amp; inside backticks will render as literal &amp;&amp; instead of &&. Replace with backtick-escaped && without HTML escaping to display the intended operator.
**Workaround**: Instead of multi-line commands, use command chaining with `&amp;&amp;` to keep everything on one line (e.g., `echo a &amp;&amp; echo b` instead of typing each command on a separate line).

Copy link
Contributor Author

@KJ7LNW KJ7LNW left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than that missing header it looks great. Thank you for cleaning that up!


---

## Known Issues and Workarounds
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you want to keep this header:

---
## Known Issues and Workarounds

@hannesrudolph hannesrudolph merged commit 1fa6a3f into RooCodeInc:main Jun 19, 2025
1 of 2 checks passed
@github-project-automation github-project-automation bot moved this from PR [Draft / In Progress] to Done in Roo Code Roadmap Jun 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants

Comments