Get the FREE Ultimate OpenClaw Setup Guide →

using-git-worktrees

Scanned
npx machina-cli add skill ed3dai/ed3d-plugins/using-git-worktrees --openclaw
Files (1)
SKILL.md
5.3 KB

Using Git Worktrees

Overview

Git worktrees create isolated workspaces sharing the same repository, allowing work on multiple branches simultaneously without switching.

Core principle: Systematic directory selection + safety verification = reliable isolation.

Announce at start: "I'm using the using-git-worktrees skill to set up an isolated workspace."

Directory Selection Process

Follow this priority order:

1. Check Existing Directories

# Check in priority order
ls -d .worktrees 2>/dev/null     # Preferred (hidden)
ls -d worktrees 2>/dev/null      # Alternative

If found: Use that directory. If both exist, .worktrees wins.

2. Check CLAUDE.md

grep -i "worktree.*director" CLAUDE.md 2>/dev/null

If preference specified: Use it without asking.

3. Ask User

If no directory exists and no CLAUDE.md preference:

No worktree directory found. Where should I create worktrees?

1. .worktrees/ (project-local, hidden)
2. ~/.claude/worktrees/<project-name>/ (global location)

Which would you prefer?

Safety Verification

For Project-Local Directories (.worktrees or worktrees)

MUST verify .gitignore before creating worktree:

# Check if directory pattern in .gitignore
grep -q "^\.worktrees/$" .gitignore || grep -q "^worktrees/$" .gitignore

If NOT in .gitignore:

Per Jesse's rule "Fix broken things immediately":

  1. Add appropriate line to .gitignore
  2. Commit the change
  3. Proceed with worktree creation

Why critical: Prevents accidentally committing worktree contents to repository.

For Global Directory (~/.claude/worktrees)

No .gitignore verification needed - outside project entirely.

Creation Steps

1. Detect Project Name

project=$(basename "$(git rev-parse --show-toplevel)")

2. Create Worktree

# Determine full path
case $LOCATION in
  .worktrees|worktrees)
    path="$LOCATION/$BRANCH_NAME"
    ;;
  ~/.claude/worktrees/*)
    path="~/.claude/worktrees/$project/$BRANCH_NAME"
    ;;
esac

# Create worktree with new branch
git worktree add "$path" -b "$BRANCH_NAME"
cd "$path"

3. Run Project Setup

Auto-detect and run appropriate setup:

# Node.js
if [ -f package.json ]; then npm install; fi

# Rust
if [ -f Cargo.toml ]; then cargo build; fi

# Python
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
if [ -f pyproject.toml ]; then poetry install; fi

# Go
if [ -f go.mod ]; then go mod download; fi

4. Verify Clean Baseline

Run tests to ensure worktree starts clean:

# Examples - use project-appropriate command
npm test
cargo test
pytest
go test ./...

If tests fail: Report failures, ask whether to proceed or investigate.

If tests pass: Report ready.

5. Report Location

Worktree ready at <full-path>
Tests passing (<N> tests, 0 failures)
Ready to implement <feature-name>

Quick Reference

SituationAction
.worktrees/ existsUse it (verify .gitignore)
worktrees/ existsUse it (verify .gitignore)
Both existUse .worktrees/
Neither existsCheck CLAUDE.md → Ask user
Directory not in .gitignoreAdd it immediately + commit
Tests fail during baselineReport failures + ask
No package.json/Cargo.tomlSkip dependency install

Common Mistakes

Skipping .gitignore verification

  • Problem: Worktree contents get tracked, pollute git status
  • Fix: Always grep .gitignore before creating project-local worktree

Assuming directory location

  • Problem: Creates inconsistency, violates project conventions
  • Fix: Follow priority: existing > CLAUDE.md > ask

Proceeding with failing tests

  • Problem: Can't distinguish new bugs from pre-existing issues
  • Fix: Report failures, get explicit permission to proceed

Hardcoding setup commands

  • Problem: Breaks on projects using different tools
  • Fix: Auto-detect from project files (package.json, etc.)

Example Workflow

You: I'm using the using-git-worktrees skill to set up an isolated workspace.

[Check .worktrees/ - exists]
[Verify .gitignore - contains .worktrees/]
[Create worktree: git worktree add .worktrees/auth -b feature/auth]
[Run npm install]
[Run npm test - 47 passing]

Worktree ready at /Users/jesse/myproject/.worktrees/auth
Tests passing (47 tests, 0 failures)
Ready to implement auth feature

Red Flags

Never:

  • Create worktree without .gitignore verification (project-local)
  • Skip baseline test verification
  • Proceed with failing tests without asking
  • Assume directory location when ambiguous
  • Skip CLAUDE.md check

Always:

  • Follow directory priority: existing > CLAUDE.md > ask
  • Verify .gitignore for project-local
  • Auto-detect and run project setup
  • Verify clean test baseline

Integration

Called by:

  • brainstorming (Phase 4) - REQUIRED when design is approved and implementation follows
  • Any skill needing isolated workspace

Pairs with:

  • finishing-a-development-branch - REQUIRED for cleanup after work complete
  • executing-an-implementation-plan - Work happens in this worktree

Source

git clone https://github.com/ed3dai/ed3d-plugins/blob/main/plugins/ed3d-plan-and-execute/skills/using-git-worktrees/SKILL.mdView on GitHub

Overview

Git worktrees enable isolated workspaces that share the same repository, allowing you to work on multiple branches without constantly switching. This skill uses a deterministic directory-selection process plus safety verification to ensure reliable isolation before starting feature work. It also announces when it begins setting up the isolated workspace.

How This Skill Works

The process follows a priority-driven directory selection: first check for existing .worktrees (preferred), then worktrees, then CLAUDE.md preferences, and finally prompt the user if none exist. For project-local directories, it verifies .gitignore contains the worktree pattern and, per Jesse's rule, adds the line, commits the change, and proceeds. It creates the worktree with git worktree add, switches into the new path, auto-detects the project setup (Node.js, Rust, Python, Go) and installs/builds as needed, then runs a baseline test suite to confirm a clean starting point.

When to Use It

  • Starting feature work that needs isolation from your current workspace.
  • Before executing implementation plans to avoid polluting the main workspace.
  • When you need to work on multiple branches concurrently without frequent checkouts.
  • When a CLAUDE.md preference specifies a particular worktree directory.
  • When you want automatic setup and a clean baseline with tests after creating the worktree.

Quick Start

  1. Step 1: Determine the destination directory using priority (existing .worktrees, then worktrees, then CLAUDE.md, else prompt).
  2. Step 2: Create the worktree with git worktree add "$path" -b "$BRANCH_NAME" and cd into "$path".
  3. Step 3: Auto-detect setup (Node.js, Rust, Python, Go), install dependencies, run tests, and report readiness.

Best Practices

  • Prefer existing directories in the priority check: .worktrees first, then worktrees.
  • Respect CLAUDE.md's directory preference when it exists.
  • Always verify project-local .gitignore includes the worktree path before creating a new one.
  • Follow Jesse's rule: if the worktree path isn't ignored, add it to .gitignore, commit, then proceed.
  • After creating the worktree, auto-detect and install dependencies and run a clean baseline of tests.

Example Use Cases

  • Create an isolated worktree under .worktrees for a new feature in a Node.js project (package.json) to keep changes separate from main work.
  • Set up a Rust feature in a monorepo by creating a separate worktree and running cargo build before implementing changes.
  • Develop a Go service feature by using a global worktree location (~/.claude/worktrees) to avoid project-local side effects.
  • Experiment with Python data-processing changes by launching a worktree that runs pip install -r requirements.txt and pytest only for the new feature.
  • Follow CLAUDE.md guidance to use a preferred worktree directory when collaborating across multiple projects.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers