|
| 1 | +--- |
| 2 | +description: Show help for worktree-task plugin |
| 3 | +allowed-tools: "" |
| 4 | +--- |
| 5 | + |
| 6 | +# Worktree Task Plugin Help |
| 7 | + |
| 8 | +A plugin for managing large coding tasks using git worktrees and background Claude Code sessions. |
| 9 | + |
| 10 | +## Commands |
| 11 | + |
| 12 | +| Command | Description | |
| 13 | +|---------|-------------| |
| 14 | +| `/worktree-task:launch <task>` | Launch a new background task in a separate worktree | |
| 15 | +| `/worktree-task:status [name]` | Check status of all or specific task | |
| 16 | +| `/worktree-task:resume <name>` | Resume an interrupted task | |
| 17 | +| `/worktree-task:cleanup <name>` | Clean up completed task and worktree | |
| 18 | +| `/worktree-task:merge <branch>` | Merge a feature branch into current branch | |
| 19 | +| `/worktree-task:rebase <branch>` | Rebase current branch onto a feature branch | |
| 20 | +| `/worktree-task:help` | Show this help message | |
| 21 | + |
| 22 | +## Quick Start |
| 23 | + |
| 24 | +```bash |
| 25 | +# 1. Launch a complex task in the background |
| 26 | +/worktree-task:launch "Implement user authentication with OAuth2" |
| 27 | + |
| 28 | +# 2. Check progress |
| 29 | +/worktree-task:status |
| 30 | + |
| 31 | +# 3. When done, merge the changes |
| 32 | +/worktree-task:merge feature-auth |
| 33 | + |
| 34 | +# 4. Clean up |
| 35 | +/worktree-task:cleanup feature-auth |
| 36 | +``` |
| 37 | + |
| 38 | +## How It Works |
| 39 | + |
| 40 | +1. **Launch** creates a git worktree (isolated copy of your repo) and spawns a Claude Code instance in a tmux session |
| 41 | +2. **Monitor** via `/worktree-task:status` to see progress, logs, and completion state |
| 42 | +3. **Resume** if task gets interrupted (rate limits, API errors, network issues) |
| 43 | +4. **Merge/Rebase** with automatic conflict resolution powered by Claude |
| 44 | +5. **Cleanup** removes the tmux session and worktree when done |
| 45 | + |
| 46 | +## Best Practices |
| 47 | + |
| 48 | +- Use for tasks that take 10+ minutes or require extensive changes |
| 49 | +- Keep task descriptions clear and specific |
| 50 | +- Check status periodically to monitor progress |
| 51 | +- Use `--keep-worktree` with cleanup if you want to review changes first |
| 52 | + |
| 53 | +## File Locations |
| 54 | + |
| 55 | +- Worktrees: Created in parent directory of your repo (e.g., `../worktree-task-<name>`) |
| 56 | +- Task prompts: `/tmp/claude_task_prompt.txt` (temporary) |
| 57 | +- Monitor logs: `<plugin-dir>/.monitor_cron.log` |
| 58 | + |
| 59 | +## Requirements |
| 60 | + |
| 61 | +- macOS (for notifications) |
| 62 | +- tmux |
| 63 | +- git |
| 64 | +- Python 3.8+ |
| 65 | + |
| 66 | +## Links |
| 67 | + |
| 68 | +- GitHub: https://github.com/ourines/worktree-task-plugin |
| 69 | +- Issues: https://github.com/ourines/worktree-task-plugin/issues |
0 commit comments