docs: add Worktrunk as recommended worktree tool#116
Conversation
- Document Worktrunk (wt) as the primary worktree management tool - Show installation, key commands (switch, list, merge) - Keep worktree-helper.sh as fallback for no-dependency environments - Update session spawning example to use wt switch -c -x
Summary of ChangesHello @marcusquinn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates the project's Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughREADME updates replace Worktree/script-based examples with Worktrunk (wt) usage, change "OpenCode session" to "AI session", add Worktrunk documentation references, and bump project version metadata in Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
🔍 Code Quality Report�[0;35m[MONITOR]�[0m Code Review Monitoring Report �[0;34m[INFO]�[0m Latest Quality Status: �[0;34m[INFO]�[0m Recent monitoring activity: 📈 Current Quality Metrics
Generated on: Sat Jan 17 16:00:46 UTC 2026 Generated by AI DevOps Framework Code Review Monitoring |
🤖 Augment PR SummarySummary: Updates the main README to recommend Worktrunk ( Changes:
🤖 Was this summary useful? React with 👍 or 👎 |
![augmentcode[bot]](https://avatars.githubusercontent.com/in/1027498?s=60&v=4){kind=small}
README.md
Outdated
| # Create worktree + cd into it | ||
| wt switch -c feature/my-feature | ||
|
|
||
| # Create worktree + start Claude Code |
There was a problem hiding this comment.
This section uses a claude example (wt ... -x claude) but the later session example uses opencode; consider clarifying that -x can launch any AI CLI (or keep one tool name consistent) to avoid confusing readers about which command is expected.
🤖 Was this useful? React with 👍 or 👎
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to recommend Worktrunk (wt) as the primary tool for managing Git worktrees, moving the existing worktree-helper.sh script to a fallback option. The changes are well-structured and make the documentation clearer by highlighting a tool with a better user experience. I've provided a few suggestions to further improve the clarity and completeness of the documentation, particularly around the installation instructions for Worktrunk and the usage of the fallback script to ensure users have all the necessary information.
README.md
Outdated
| cd ../project-feature-next-feature && opencode | ||
| # Worktree-based (isolated branch) - recommended | ||
| wt switch -c -x opencode feature/next-feature # Worktrunk: create + start OpenCode | ||
| # Or fallback: ~/.aidevops/agents/scripts/worktree-helper.sh add feature/next-feature |
There was a problem hiding this comment.
The fallback command provided is incomplete and could be misleading. The recommended wt command it's an alternative to creates a worktree, switches to it, and executes opencode. The current fallback only shows the creation step. To be a true alternative, it should show all steps, including changing into the new worktree directory and starting opencode, similar to how it was before this change.
| # Or fallback: ~/.aidevops/agents/scripts/worktree-helper.sh add feature/next-feature | |
| # Or fallback: | |
| # ~/.aidevops/agents/scripts/worktree-helper.sh add feature/next-feature | |
| # cd <path-to-worktree> && opencode |
| ~/.aidevops/agents/scripts/worktree-helper.sh add feature/my-feature | ||
| # Creates: ~/Git/aidevops-feature-my-feature/ | ||
| # Install (macOS/Linux) | ||
| brew install max-sixty/worktrunk/wt && wt config shell install |
There was a problem hiding this comment.
For the shell integration from wt config shell install to take effect, the user needs to restart their shell. It would be helpful to add a comment mentioning this to improve the user experience.
| brew install max-sixty/worktrunk/wt && wt config shell install | |
| brew install max-sixty/worktrunk/wt && wt config shell install | |
| # Restart your shell for the changes to take effect |
|
|
||
| # Clean up after merge | ||
| ```bash | ||
| ~/.aidevops/agents/scripts/worktree-helper.sh add feature/my-feature |
There was a problem hiding this comment.
The previous version of the documentation included a helpful comment indicating the path where the worktree is created (e.g., # Creates: ~/Git/aidevops-feature-my-feature/). This was useful for users to know how to navigate to the new worktree. Since worktree-helper.sh is now the fallback, it would be beneficial to add this explanatory comment back to guide users.
| ~/.aidevops/agents/scripts/worktree-helper.sh add feature/my-feature | |
| ~/.aidevops/agents/scripts/worktree-helper.sh add feature/my-feature | |
| # Note: This creates a new directory for the worktree, e.g., ~/Git/aidevops-feature-my-feature/ |
- Add shell restart note after wt config shell install - Clarify -x flag runs any AI CLI command - Add path comment to fallback worktree-helper.sh example - Expand fallback in session spawning to show full workflow
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
60-60: Fix version badge to match release version.Pipeline validation failed: the version badge shows
2.59.0but should show2.60.0.🔧 Proposed fix
-[](https://github.com/marcusquinn/aidevops/releases) +[](https://github.com/marcusquinn/aidevops/releases)
🔍 Code Quality Report�[0;35m[MONITOR]�[0m Code Review Monitoring Report �[0;34m[INFO]�[0m Latest Quality Status: �[0;34m[INFO]�[0m Recent monitoring activity: 📈 Current Quality Metrics
Generated on: Sat Jan 17 16:03:45 UTC 2026 Generated by AI DevOps Framework Code Review Monitoring |
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
60-60: Critical: Version badge mismatch detected by pipeline.The version badge shows
2.59.0but the pipeline expects2.60.0. This appears to be unrelated to the Worktrunk documentation changes but needs to be corrected before merge.🔧 Proposed fix
-[](https://github.com/marcusquinn/aidevops/releases) +[](https://github.com/marcusquinn/aidevops/releases)
Fix version inconsistency: - README.md badge: 2.59.0 → 2.60.0 - sonar-project.properties: 2.59.0 → 2.60.0 - setup.sh header: 2.59.0 → 2.60.0
|
🔍 Code Quality Report�[0;35m[MONITOR]�[0m Code Review Monitoring Report �[0;34m[INFO]�[0m Latest Quality Status: �[0;34m[INFO]�[0m Recent monitoring activity: 📈 Current Quality Metrics
Generated on: Sat Jan 17 16:33:45 UTC 2026 Generated by AI DevOps Framework Code Review Monitoring |
1 participant
Summary
wt) as the primary worktree management tool in READMEworktree-helper.shas fallback for no-dependency environmentswt switch -c -xChanges
Why
Worktrunk provides a better UX than raw git worktree commands:
wt listThe framework already documents Worktrunk in
.agent/tools/git/worktrunk.mdand.agent/workflows/worktree.md, but the main README was missing this recommendation.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.