Using Git Worktrees

作者 obra5bf4e7801107無授權條款292K 個星標收錄於 2026年9月23日更新於 2026年9月23日儲存庫昨天更新

Use when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallback

AI 產生的概覽

為功能開發建立隔離的 git worktree 工作區,並執行專案初始化與基線測試。

功能
先偵測目前是否已在連結的 worktree 或子模組中,再優先使用平台原生的 worktree 工具,必要時改用人工 git worktree 建立隔離工作區。它會選擇 worktree 目錄、確認該目錄已被 git 忽略、執行專案相依套件安裝,並跑基線測試。最後回報工作區路徑、分支與測試結果,並在建立前先徵求使用者同意。
適用情境
適用於開始需要與目前工作區隔離的功能開發,或在執行實作計畫之前使用。也適合在變更前確認測試基線是乾淨的。
執行需求
僅為指示,不含指令碼。需要 git 與 git 儲存庫,以及專案本身的工具鏈來進行初始化與測試(例如 npm、cargo、pip/poetry 或 go)。除套件管理器所需之外,不需額外憑證或網路存取。

Using Git Worktrees

Overview

Ensure work happens in an isolated workspace. Prefer your platform's native worktree tools. Fall back to manual git worktrees only when no native tool is available.

Core principle: Detect existing isolation first. Then use native tools. Then fall back to git. Never fight the harness.

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

Step 0: Detect Existing Isolation

Before creating anything, check if you are already in an isolated workspace.

bash
GIT_DIR=$(cd "$(git rev-parse --git-dir)" 2>/dev/null && pwd -P)GIT_COMMON=$(cd "$(git rev-parse --git-common-dir)" 2>/dev/null && pwd -P)BRANCH=$(git branch --show-current)

Submodule guard: GIT_DIR != GIT_COMMON is also true inside git submodules. Before concluding "already in a worktree," verify you are not in a submodule:

bash
# If this returns a path, you're in a submodule, not a worktree — treat as normal repogit rev-parse --show-superproject-working-tree 2>/dev/null

If GIT_DIR != GIT_COMMON (and not a submodule): You are already in a linked worktree. Skip to Step 2 (Project Setup). Do NOT create another worktree.

Report with branch state:

  • On a branch: "Already in isolated workspace at <path> on branch <name>."
  • Detached HEAD: "Already in isolated workspace at <path> (detached HEAD, externally managed). Branch creation needed at finish time."

If GIT_DIR == GIT_COMMON (or in a submodule): You are in a normal repo checkout.

Has the user already indicated their worktree preference in your instructions? If not, ask for consent before creating a worktree:

"Would you like me to set up an isolated worktree? It protects your current branch from changes."

Honor any existing declared preference without asking. If the user declines consent, work in place and skip to Step 2.

Step 1: Create Isolated Workspace

You have two mechanisms. Try them in this order.

1a. Native Worktree Tools (preferred)

The user has asked for an isolated workspace (Step 0 consent). Do you already have a way to create a worktree? It might be a tool with a name like EnterWorktree, WorktreeCreate, a /worktree command, or a --worktree flag. If you do, use it and skip to Step 2.

Native tools handle directory placement, branch creation, and cleanup automatically. Using git worktree add when you have a native tool creates phantom state your harness can't see or manage.

Only proceed to Step 1b if you have no native worktree tool available.

1b. Git Worktree Fallback

Only use this if Step 1a does not apply — you have no native worktree tool available. Create a worktree manually using git.

Directory Selection

Follow this priority order. Explicit user preference always beats observed filesystem state.

  1. Check your instructions for a declared worktree directory preference. If the user has already specified one, use it without asking.

  2. Check for an existing project-local worktree directory:

    bash
    ls -d .worktrees 2>/dev/null     # Preferred (hidden)ls -d worktrees 2>/dev/null      # Alternative

    If found, use it. If both exist, .worktrees wins.

  3. If there is no other guidance available, default to .worktrees/ at the project root.

Safety Verification (project-local directories only)

MUST verify directory is ignored before creating worktree:

bash
git check-ignore -q .worktrees 2>/dev/null || git check-ignore -q worktrees 2>/dev/null

If NOT ignored: Add to .gitignore, commit the change, then proceed.

Why critical: Prevents accidentally committing worktree contents to repository.

Create the Worktree
bash
# Determine path based on chosen locationpath="$LOCATION/$BRANCH_NAME"
git worktree add "$path" -b "$BRANCH_NAME"cd "$path"

Sandbox fallback: If git worktree add fails with a permission error (sandbox denial), tell the user the sandbox blocked worktree creation and you're working in the current directory instead. Then run setup and baseline tests in place.

Step 2: Project Setup

Auto-detect and run appropriate setup:

bash
# Node.jsif [ -f package.json ]; then npm install; fi
# Rustif [ -f Cargo.toml ]; then cargo build; fi
# Pythonif [ -f requirements.txt ]; then pip install -r requirements.txt; fiif [ -f pyproject.toml ]; then poetry install; fi
# Goif [ -f go.mod ]; then go mod download; fi

Step 3: Verify Clean Baseline

Run tests to ensure workspace starts clean:

bash
# Use project-appropriate commandnpm test / cargo test / pytest / go test ./...

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

If tests pass: Report ready.

Report

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

Quick Reference

SituationAction
Already in linked worktreeSkip creation (Step 0)
In a submoduleTreat as normal repo (Step 0 guard)
Native worktree tool availableUse it (Step 1a)
No native toolGit worktree fallback (Step 1b)
.worktrees/ existsUse it (verify ignored)
worktrees/ existsUse it (verify ignored)
Both existUse .worktrees/
Neither existsCheck instruction file, then default .worktrees/
Directory not ignoredAdd to .gitignore + commit
Permission error on createSandbox fallback, work in place
Tests fail during baselineReport failures + ask
No package.json/Cargo.tomlSkip dependency install

Common Rationalizations

ExcuseReality
"I'm obviously not in a worktree — no need to check"Run Step 0. Harness-created isolation and submodules both fool eyeballing; the detection commands settle it.
"git worktree add is quicker than hunting for a native tool"A native tool (e.g. EnterWorktree) owns placement, branching, and cleanup. Bypassing it is the #1 mistake — it creates phantom state your harness can't see or manage.
"The worktree directory is surely ignored already"Run git check-ignore. An unignored worktree directory commits the whole tree into the repo.
"Any directory name works"Explicit instructions beat an existing project-local directory, which beats the .worktrees/ default.
"The workspace is fresh — baseline tests can wait"A dirty baseline makes every later failure ambiguous. Run the tests now; proceeding past failures is your human partner's call.

來源與署名

來源:obra/superpowers位於skills/using-git-worktrees提交5bf4e78

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架