feat(plugin): reorganize compounding-engineering v2.0.0
Major restructure of the compounding-engineering plugin: ## Agents (24 total, now categorized) - review/ (10): architecture-strategist, code-simplicity-reviewer, data-integrity-guardian, dhh-rails-reviewer, kieran-rails-reviewer, kieran-python-reviewer, kieran-typescript-reviewer, pattern-recognition-specialist, performance-oracle, security-sentinel - research/ (4): best-practices-researcher, framework-docs-researcher, git-history-analyzer, repo-research-analyst - design/ (3): design-implementation-reviewer, design-iterator, figma-design-sync - workflow/ (6): bug-reproduction-validator, every-style-editor, feedback-codifier, lint, pr-comment-resolver, spec-flow-analyzer - docs/ (1): ankane-readme-writer ## Commands (15 total) - Moved workflow commands to commands/workflows/ subdirectory - Added: changelog, create-agent-skill, heal-skill, plan_review, prime, reproduce-bug, resolve_parallel, resolve_pr_parallel ## Skills (11 total) - Added: andrew-kane-gem-writer, codify-docs, create-agent-skills, dhh-ruby-style, dspy-ruby, every-style-editor, file-todos, frontend-design, git-worktree, skill-creator - Kept: gemini-imagegen 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
272
plugins/compounding-engineering/skills/git-worktree/SKILL.md
Normal file
272
plugins/compounding-engineering/skills/git-worktree/SKILL.md
Normal file
@@ -0,0 +1,272 @@
|
||||
---
|
||||
name: git-worktree
|
||||
description: This skill manages Git worktrees for isolated parallel development. It handles creating, listing, switching, and cleaning up worktrees with a simple interactive interface, following KISS principles.
|
||||
---
|
||||
|
||||
# Git Worktree Manager
|
||||
|
||||
This skill provides a unified interface for managing Git worktrees across your development workflow. Whether you're reviewing PRs in isolation or working on features in parallel, this skill handles all the complexity.
|
||||
|
||||
## What This Skill Does
|
||||
|
||||
- **Create worktrees** from main branch with clear branch names
|
||||
- **List worktrees** with current status
|
||||
- **Switch between worktrees** for parallel work
|
||||
- **Clean up completed worktrees** automatically
|
||||
- **Interactive confirmations** at each step
|
||||
- **Automatic .gitignore management** for worktree directory
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
Use this skill in these scenarios:
|
||||
|
||||
1. **Code Review (`/workflows:review`)**: If NOT already on the PR branch, offer worktree for isolated review
|
||||
2. **Feature Work (`/workflows:work`)**: Always ask if user wants parallel worktree or live branch work
|
||||
3. **Parallel Development**: When working on multiple features simultaneously
|
||||
4. **Cleanup**: After completing work in a worktree
|
||||
|
||||
## How to Use
|
||||
|
||||
### In Claude Code Workflows
|
||||
|
||||
The skill is automatically called from `/workflows:review` and `/workflows:work` commands:
|
||||
|
||||
```
|
||||
# For review: offers worktree if not on PR branch
|
||||
# For work: always asks - new branch or worktree?
|
||||
```
|
||||
|
||||
### Manual Usage
|
||||
|
||||
You can also invoke the skill directly from bash:
|
||||
|
||||
```bash
|
||||
# Create a new worktree
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh create feature-login
|
||||
|
||||
# List all worktrees
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh list
|
||||
|
||||
# Switch to a worktree
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh switch feature-login
|
||||
|
||||
# Clean up completed worktrees
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh cleanup
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
### `create <branch-name> [from-branch]`
|
||||
|
||||
Creates a new worktree with the given branch name.
|
||||
|
||||
**Options:**
|
||||
- `branch-name` (required): The name for the new branch and worktree
|
||||
- `from-branch` (optional): Base branch to create from (defaults to `main`)
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh create feature-login
|
||||
```
|
||||
|
||||
**What happens:**
|
||||
1. Checks if worktree already exists
|
||||
2. Updates the base branch from remote
|
||||
3. Creates new worktree and branch
|
||||
4. Shows path for cd-ing to the worktree
|
||||
|
||||
### `list` or `ls`
|
||||
|
||||
Lists all available worktrees with their branches and current status.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh list
|
||||
```
|
||||
|
||||
**Output shows:**
|
||||
- Worktree name
|
||||
- Branch name
|
||||
- Which is current (marked with ✓)
|
||||
- Main repo status
|
||||
|
||||
### `switch <name>` or `go <name>`
|
||||
|
||||
Switches to an existing worktree and cd's into it.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh switch feature-login
|
||||
```
|
||||
|
||||
**Optional:**
|
||||
- If name not provided, lists available worktrees and prompts for selection
|
||||
|
||||
### `cleanup` or `clean`
|
||||
|
||||
Interactively cleans up inactive worktrees with confirmation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh cleanup
|
||||
```
|
||||
|
||||
**What happens:**
|
||||
1. Lists all inactive worktrees
|
||||
2. Asks for confirmation
|
||||
3. Removes selected worktrees
|
||||
4. Cleans up empty directories
|
||||
|
||||
## Workflow Examples
|
||||
|
||||
### Code Review with Worktree
|
||||
|
||||
```bash
|
||||
# Claude Code recognizes you're not on the PR branch
|
||||
# Offers: "Use worktree for isolated review? (y/n)"
|
||||
|
||||
# You respond: yes
|
||||
# Script runs:
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh create pr-123-feature-name
|
||||
|
||||
# You're now in isolated worktree for review
|
||||
cd .worktrees/pr-123-feature-name
|
||||
|
||||
# After review, return to main:
|
||||
cd ../..
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh cleanup
|
||||
```
|
||||
|
||||
### Parallel Feature Development
|
||||
|
||||
```bash
|
||||
# For first feature:
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh create feature-login
|
||||
|
||||
# Later, start second feature:
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh create feature-notifications
|
||||
|
||||
# List what you have:
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh list
|
||||
|
||||
# Switch between them as needed:
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh switch feature-login
|
||||
|
||||
# Return to main and cleanup when done:
|
||||
cd .
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh cleanup
|
||||
```
|
||||
|
||||
## Key Design Principles
|
||||
|
||||
### KISS (Keep It Simple, Stupid)
|
||||
|
||||
- **One manager script** handles all worktree operations
|
||||
- **Simple commands** with sensible defaults
|
||||
- **Interactive prompts** prevent accidental operations
|
||||
- **Clear naming** using branch names directly
|
||||
|
||||
### Opinionated Defaults
|
||||
|
||||
- Worktrees always created from **main** (unless specified)
|
||||
- Worktrees stored in **.worktrees/** directory
|
||||
- Branch name becomes worktree name
|
||||
- **.gitignore** automatically managed
|
||||
|
||||
### Safety First
|
||||
|
||||
- **Confirms before creating** worktrees
|
||||
- **Confirms before cleanup** to prevent accidental removal
|
||||
- **Won't remove current worktree**
|
||||
- **Clear error messages** for issues
|
||||
|
||||
## Integration with Workflows
|
||||
|
||||
### `/workflows:review`
|
||||
|
||||
Instead of always creating a worktree:
|
||||
|
||||
```
|
||||
1. Check current branch
|
||||
2. If ALREADY on PR branch → stay there, no worktree needed
|
||||
3. If DIFFERENT branch → offer worktree:
|
||||
"Use worktree for isolated review? (y/n)"
|
||||
- yes → call git-worktree skill
|
||||
- no → proceed with PR diff on current branch
|
||||
```
|
||||
|
||||
### `/workflows:work`
|
||||
|
||||
Always offer choice:
|
||||
|
||||
```
|
||||
1. Ask: "How do you want to work?
|
||||
1. New branch on current worktree (live work)
|
||||
2. Worktree (parallel work)"
|
||||
|
||||
2. If choice 1 → create new branch normally
|
||||
3. If choice 2 → call git-worktree skill to create from main
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "Worktree already exists"
|
||||
|
||||
If you see this, the script will ask if you want to switch to it instead.
|
||||
|
||||
### "Cannot remove worktree: it is the current worktree"
|
||||
|
||||
Switch out of the worktree first, then cleanup:
|
||||
|
||||
```bash
|
||||
cd /Users/kieranklaassen/rails/cora
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh cleanup
|
||||
```
|
||||
|
||||
### Lost in a worktree?
|
||||
|
||||
See where you are:
|
||||
|
||||
```bash
|
||||
bash .claude/skills/git-worktree/scripts/worktree-manager.sh list
|
||||
```
|
||||
|
||||
Navigate back to main:
|
||||
|
||||
```bash
|
||||
cd $(git rev-parse --show-toplevel)
|
||||
```
|
||||
|
||||
## Technical Details
|
||||
|
||||
### Directory Structure
|
||||
|
||||
```
|
||||
.worktrees/
|
||||
├── feature-login/ # Worktree 1
|
||||
│ ├── .git
|
||||
│ ├── app/
|
||||
│ └── ...
|
||||
├── feature-notifications/ # Worktree 2
|
||||
│ ├── .git
|
||||
│ ├── app/
|
||||
│ └── ...
|
||||
└── ...
|
||||
|
||||
.gitignore (updated to include .worktrees)
|
||||
```
|
||||
|
||||
### How It Works
|
||||
|
||||
- Uses `git worktree add` for isolated environments
|
||||
- Each worktree has its own branch
|
||||
- Changes in one worktree don't affect others
|
||||
- Share git history with main repo
|
||||
- Can push from any worktree
|
||||
|
||||
### Performance
|
||||
|
||||
- Worktrees are lightweight (just file system links)
|
||||
- No repository duplication
|
||||
- Shared git objects for efficiency
|
||||
- Much faster than cloning or stashing/switching
|
||||
255
plugins/compounding-engineering/skills/git-worktree/scripts/worktree-manager.sh
Executable file
255
plugins/compounding-engineering/skills/git-worktree/scripts/worktree-manager.sh
Executable file
@@ -0,0 +1,255 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Git Worktree Manager
|
||||
# Handles creating, listing, switching, and cleaning up Git worktrees
|
||||
# KISS principle: Simple, interactive, opinionated
|
||||
|
||||
set -e
|
||||
|
||||
# Colors for output
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# Get repo root
|
||||
GIT_ROOT=$(git rev-parse --show-toplevel)
|
||||
WORKTREE_DIR="$GIT_ROOT/.worktrees"
|
||||
|
||||
# Ensure .worktrees is in .gitignore
|
||||
ensure_gitignore() {
|
||||
if ! grep -q "^\.worktrees$" "$GIT_ROOT/.gitignore" 2>/dev/null; then
|
||||
echo ".worktrees" >> "$GIT_ROOT/.gitignore"
|
||||
fi
|
||||
}
|
||||
|
||||
# Create a new worktree
|
||||
create_worktree() {
|
||||
local branch_name="$1"
|
||||
local from_branch="${2:-main}"
|
||||
|
||||
if [[ -z "$branch_name" ]]; then
|
||||
echo -e "${RED}Error: Branch name required${NC}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
local worktree_path="$WORKTREE_DIR/$branch_name"
|
||||
|
||||
# Check if worktree already exists
|
||||
if [[ -d "$worktree_path" ]]; then
|
||||
echo -e "${YELLOW}Worktree already exists at: $worktree_path${NC}"
|
||||
echo -e "Switch to it instead? (y/n)"
|
||||
read -r response
|
||||
if [[ "$response" == "y" ]]; then
|
||||
switch_worktree "$branch_name"
|
||||
fi
|
||||
return
|
||||
fi
|
||||
|
||||
echo -e "${BLUE}Creating worktree: $branch_name${NC}"
|
||||
echo " From: $from_branch"
|
||||
echo " Path: $worktree_path"
|
||||
echo ""
|
||||
echo "Proceed? (y/n)"
|
||||
read -r response
|
||||
|
||||
if [[ "$response" != "y" ]]; then
|
||||
echo -e "${YELLOW}Cancelled${NC}"
|
||||
return
|
||||
fi
|
||||
|
||||
# Update main branch
|
||||
echo -e "${BLUE}Updating $from_branch...${NC}"
|
||||
git checkout "$from_branch"
|
||||
git pull origin "$from_branch" || true
|
||||
|
||||
# Create worktree
|
||||
mkdir -p "$WORKTREE_DIR"
|
||||
ensure_gitignore
|
||||
|
||||
echo -e "${BLUE}Creating worktree...${NC}"
|
||||
git worktree add -b "$branch_name" "$worktree_path" "$from_branch"
|
||||
|
||||
echo -e "${GREEN}✓ Worktree created successfully!${NC}"
|
||||
echo ""
|
||||
echo "To switch to this worktree:"
|
||||
echo -e "${BLUE}cd $worktree_path${NC}"
|
||||
echo ""
|
||||
}
|
||||
|
||||
# List all worktrees
|
||||
list_worktrees() {
|
||||
echo -e "${BLUE}Available worktrees:${NC}"
|
||||
echo ""
|
||||
|
||||
if [[ ! -d "$WORKTREE_DIR" ]]; then
|
||||
echo -e "${YELLOW}No worktrees found${NC}"
|
||||
return
|
||||
fi
|
||||
|
||||
local count=0
|
||||
for worktree_path in "$WORKTREE_DIR"/*; do
|
||||
if [[ -d "$worktree_path" && -d "$worktree_path/.git" ]]; then
|
||||
count=$((count + 1))
|
||||
local worktree_name=$(basename "$worktree_path")
|
||||
local branch=$(git -C "$worktree_path" rev-parse --abbrev-ref HEAD 2>/dev/null || echo "unknown")
|
||||
|
||||
if [[ "$PWD" == "$worktree_path" ]]; then
|
||||
echo -e "${GREEN}✓ $worktree_name${NC} (current) → branch: $branch"
|
||||
else
|
||||
echo -e " $worktree_name → branch: $branch"
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
if [[ $count -eq 0 ]]; then
|
||||
echo -e "${YELLOW}No worktrees found${NC}"
|
||||
else
|
||||
echo ""
|
||||
echo -e "${BLUE}Total: $count worktree(s)${NC}"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${BLUE}Main repository:${NC}"
|
||||
local main_branch=$(git rev-parse --abbrev-ref HEAD 2>/dev/null || echo "unknown")
|
||||
echo " Branch: $main_branch"
|
||||
echo " Path: $GIT_ROOT"
|
||||
}
|
||||
|
||||
# Switch to a worktree
|
||||
switch_worktree() {
|
||||
local worktree_name="$1"
|
||||
|
||||
if [[ -z "$worktree_name" ]]; then
|
||||
list_worktrees
|
||||
echo -e "${BLUE}Switch to which worktree? (enter name)${NC}"
|
||||
read -r worktree_name
|
||||
fi
|
||||
|
||||
local worktree_path="$WORKTREE_DIR/$worktree_name"
|
||||
|
||||
if [[ ! -d "$worktree_path" ]]; then
|
||||
echo -e "${RED}Error: Worktree not found: $worktree_name${NC}"
|
||||
echo ""
|
||||
list_worktrees
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo -e "${GREEN}Switching to worktree: $worktree_name${NC}"
|
||||
cd "$worktree_path"
|
||||
echo -e "${BLUE}Now in: $(pwd)${NC}"
|
||||
}
|
||||
|
||||
# Clean up completed worktrees
|
||||
cleanup_worktrees() {
|
||||
if [[ ! -d "$WORKTREE_DIR" ]]; then
|
||||
echo -e "${YELLOW}No worktrees to clean up${NC}"
|
||||
return
|
||||
fi
|
||||
|
||||
echo -e "${BLUE}Checking for completed worktrees...${NC}"
|
||||
echo ""
|
||||
|
||||
local found=0
|
||||
local to_remove=()
|
||||
|
||||
for worktree_path in "$WORKTREE_DIR"/*; do
|
||||
if [[ -d "$worktree_path" && -d "$worktree_path/.git" ]]; then
|
||||
local worktree_name=$(basename "$worktree_path")
|
||||
|
||||
# Skip if current worktree
|
||||
if [[ "$PWD" == "$worktree_path" ]]; then
|
||||
echo -e "${YELLOW}(skip) $worktree_name - currently active${NC}"
|
||||
continue
|
||||
fi
|
||||
|
||||
found=$((found + 1))
|
||||
to_remove+=("$worktree_path")
|
||||
echo -e "${YELLOW}• $worktree_name${NC}"
|
||||
fi
|
||||
done
|
||||
|
||||
if [[ $found -eq 0 ]]; then
|
||||
echo -e "${GREEN}No inactive worktrees to clean up${NC}"
|
||||
return
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "Remove $found worktree(s)? (y/n)"
|
||||
read -r response
|
||||
|
||||
if [[ "$response" != "y" ]]; then
|
||||
echo -e "${YELLOW}Cleanup cancelled${NC}"
|
||||
return
|
||||
fi
|
||||
|
||||
echo -e "${BLUE}Cleaning up worktrees...${NC}"
|
||||
for worktree_path in "${to_remove[@]}"; do
|
||||
local worktree_name=$(basename "$worktree_path")
|
||||
git worktree remove "$worktree_path" --force 2>/dev/null || true
|
||||
echo -e "${GREEN}✓ Removed: $worktree_name${NC}"
|
||||
done
|
||||
|
||||
# Clean up empty directory if nothing left
|
||||
if [[ -z "$(ls -A "$WORKTREE_DIR" 2>/dev/null)" ]]; then
|
||||
rmdir "$WORKTREE_DIR" 2>/dev/null || true
|
||||
fi
|
||||
|
||||
echo -e "${GREEN}Cleanup complete!${NC}"
|
||||
}
|
||||
|
||||
# Main command handler
|
||||
main() {
|
||||
local command="${1:-list}"
|
||||
|
||||
case "$command" in
|
||||
create)
|
||||
create_worktree "$2" "$3"
|
||||
;;
|
||||
list|ls)
|
||||
list_worktrees
|
||||
;;
|
||||
switch|go)
|
||||
switch_worktree "$2"
|
||||
;;
|
||||
cleanup|clean)
|
||||
cleanup_worktrees
|
||||
;;
|
||||
help)
|
||||
show_help
|
||||
;;
|
||||
*)
|
||||
echo -e "${RED}Unknown command: $command${NC}"
|
||||
echo ""
|
||||
show_help
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
show_help() {
|
||||
cat << EOF
|
||||
Git Worktree Manager
|
||||
|
||||
Usage: worktree-manager.sh <command> [options]
|
||||
|
||||
Commands:
|
||||
create <branch-name> [from-branch] Create new worktree
|
||||
(from-branch defaults to main)
|
||||
list | ls List all worktrees
|
||||
switch | go [name] Switch to worktree
|
||||
cleanup | clean Clean up inactive worktrees
|
||||
help Show this help message
|
||||
|
||||
Examples:
|
||||
worktree-manager.sh create feature-login
|
||||
worktree-manager.sh switch feature-login
|
||||
worktree-manager.sh cleanup
|
||||
worktree-manager.sh list
|
||||
|
||||
EOF
|
||||
}
|
||||
|
||||
# Run
|
||||
main "$@"
|
||||
Reference in New Issue
Block a user