Cursor rule

1---
2description:
3globs:
4alwaysApply: false
5---
6# Using `wt` CLI for Git Worktree Management
7 
8**Your Task: When managing Git worktrees, especially for integration with the Cursor editor, use the `wt` command-line tool. This document provides its usage instructions, examples, and important operational guidelines.**
9 
10**Initial Setup Note:** If `wt` commands fail, the tool might need to be installed globally. Refer to `https://www.npmjs.com/package/@johnlindquist/worktree` for installation instructions (e.g., `pnpm add -g @johnlindquist/worktree`).
11 
12## Operational Guidelines for AI:
13 
14- **Default Action:** When the user expresses intent related to a new worktree (e.g., "create a worktree for branch X", "start work on Y"), assume they want to create a *new* worktree using `wt new [branchName]` unless they explicitly specify another `wt` command (like `list`, `remove`, etc.).
15- **Post-Creation Pause:** After successfully creating a new worktree using `wt new`, pause and await the user's next instruction. Do not automatically proceed with other actions unless explicitly part of a larger, pre-defined plan.
16- **Dependency Installation (CRITICAL DEFAULT):** When executing `wt new`, **ALWAYS append `-i pnpm`** to the command to ensure dependencies are installed using `pnpm` by default. For example: `wt new feature/login -i pnpm`.
17 
18## `wt` Command Reference
19 
20Usage: `wt [options] [command]`
21 
22Description: Manage git worktrees and open them in the Cursor editor.
23 
24### Options:
25  `-V, --version`                       Output the version number
26  `-h, --help`                          Display help for command
27 
28### Commands:
29 
30  `new [options] [branchName]`
31    Create a new worktree for the specified branch.
32    Installs dependencies if specified (see `-i` option under command-specific options, and AI default above).
33    Opens in editor.
34 
35  `list | ls`
36    List all existing worktrees for this repository.
37 
38  `remove | rm [options] [pathOrBranch]`
39    Remove a specified worktree. Cleans up `.git/worktrees` references.
40 
41  `merge [options] <branchName>`
42    Commit changes in the target branch and merge them into the current branch, then remove the branch/worktree.
43 
44  `purge`
45    Safely remove all worktrees except for the main branch, with confirmation.
46 
47  `pr [options] <prNumber>`
48    Fetch the branch for a given GitHub PR number and create a worktree.
49 
50  `config`
51    Manage CLI configuration settings.
52 
53  `help [command]`
54    Display help for a specific command.
55 
56### Examples for `wt new`:
57 
58- `wt new feature/login -i pnpm` (AI Default: creates worktree, installs with pnpm)
59- `wt new feature/chat --checkout -i pnpm` (AI Default: creates, checks out, installs with pnpm)
60- `wt new feature/auth -p ./auth-worktree -i pnpm` (AI Default: creates at path, installs with pnpm)
61- `wt new feature/vscode -e code -i pnpm` (AI Default: creates, opens in VSCode, installs with pnpm)
62 
63*(Note: The examples above have been updated to include the AI's default `-i pnpm` behavior.)*
64 
65**REMEMBER: Use `wt` for Git worktree operations. Always assume `wt new` is the primary intent for new worktree requests and ALWAYS include `-i pnpm` with `wt new` for dependency installation.**
66