wt-manager 1.4.0 → 1.7.1

package/README.md

@@ -15,7 +15,7 @@ Git worktrees let you work on multiple branches simultaneously—but managing th
 
 `wt` gives you the dashboard Git forgot to include.
 
-![wt list output](./wt-list.png)
+![wt list output](https://raw.githubusercontent.com/achtan/git-worktree-manager/main/wt-list.png)
 
 The `wt list` command shows you everything:
 - All your worktrees with their PR status (open/draft/merged/closed)
@@ -27,48 +27,39 @@ And when you're done? `wt clean` finds all merged/closed PRs and removes their w
 
 ## Quick Start
 
-**Requirements:** Node.js 22+, Git, and [GitHub CLI](https://cli.github.com/) (`gh auth login`)
+**Requirements:** Bun 1.0+, Git, and [GitHub CLI](https://cli.github.com/) (`gh auth login`)
 
 ```bash
 # Install globally
-npm install -g .
+bun install -g wt-manager
 
 # Create a new worktree
-wt feature/my-feature
+wt new feature/my-feature
 
 # See all worktrees with PR status
 wt list
 
-# Clean up merged/closed worktrees
-wt clean
-```
+# Quick status of current worktree
+wt status
 
-### Shell Integration
+# Copy worktree path to clipboard
+wt path
 
-For the full workflow (create worktree → cd into it → open IDE → start Claude):
-
-```bash
-# Add to ~/.zshrc
-eval "$(wt init)"
+# Clean up merged/closed worktrees
+wt clean
 
-# To initialize a new worktree and branch call
-wt feature/my-feature
-# To navigate to it, open WebStorm, and start Claude, run:
-wtl ../repo-worktrees/feature-my-feature
+# Check environment setup
+wt doctor
 ```
 
 ## Commands
 
-### `wt <branch-name> [base-branch]`
 ### `wt new <branch-name> [base-branch]`
 
 Create a new worktree for a new branch. Worktrees are created in `../<repo>-worktrees/` directory.
 
 ```bash
-# Create worktree from default branch (shorthand)
-wt feature/new-feature
-
-# Create worktree from default branch (explicit)
+# Create worktree from default branch
 wt new feature/new-feature
 
 # Create worktree from specific base branch
@@ -84,12 +75,11 @@ wt new feature/new-feature develop
 - Converts slashes in branch names to dashes for directory names (e.g., `feature/foo` → `feature-foo`)
 - Shows spinner during creation
 - Fails if branch already exists locally
-- Symlinks `.env` file from main worktree if present
-- Copies `.claude/settings.local.json` from main worktree if present
-- Copies WebStorm `.idea` settings from main worktree (run configurations, code styles, inspection profiles, scopes, and project files)
+- Copies/symlinks files based on `.wtrc.js` config (see [Configuration](#configuration))
+- Runs post-create commands from config
 - Copies worktree path to clipboard for easy navigation
 
-### `wt list`
+### `wt list` (alias: `ls`)
 
 List all worktrees with their status, PR information, and branch details.
 
@@ -186,7 +176,7 @@ Removing feature-old...
 Run 'wt list' to see remaining worktrees.
 ```
 
-### `wt remove <name>`
+### `wt remove <name>` (alias: `rm`)
 
 Remove a specific worktree by name. Interactive with safety prompts for uncommitted changes and unpushed commits.
 
@@ -240,26 +230,174 @@ Modified:
 Run 'wt list' to see remaining worktrees
 ```
 
+### `wt path [name]`
+
+Select a worktree interactively and copy its path to clipboard. Useful for quick navigation.
+
+```bash
+# Interactive selection
+wt path
+
+# Fuzzy match and copy directly
+wt path auth
+
+# Quiet mode for scripting (prints raw path, no clipboard)
+wt path -q feature
+cd $(wt path -q feature)
+```
+
+**Arguments:**
+- `[name]` - Optional fuzzy match on branch or directory name
+
+**Options:**
+- `-q, --quiet` - Output path only (for scripting). Requires name argument.
+
+**Behavior:**
+- Without argument: Shows interactive list of worktrees to select from
+- With argument: Fuzzy matches and copies path directly to clipboard
+- With `-q`: Prints raw path to stdout (no spinner, no clipboard, no colors)
+- Shows PR status and ahead/behind counts in the selection list
+
+**Example:**
+```
+? Select worktree:
+❯ ● feature-auth                  (↑2 ↓0) [open]
+  ○ feature-api                   (↑5 ↓1) [draft]
+  ○ bugfix-login                  [merged]
+
+✓ Copied to clipboard: /path/to/repo-worktrees/feature-auth
+```
+
+### `wt status`
+
+Show quick status of the current worktree.
+
+```bash
+wt status
+```
+
+**Output includes:**
+- Branch name with ahead/behind counts
+- PR status and check runs (if available)
+- Modified and untracked file counts
+
+**Example output:**
+```
+feature/auth (↑2 ↓5)
+PR #42 open - ✓ checks passing
+https://github.com/owner/repo/pull/42
+3 modified, 1 untracked
+```
+
 ### `wt init`
 
-Output shell function for `~/.zshrc` integration. Creates a `wtl` command that automates the full workflow.
+Initialize a `.wtrc.js` configuration file in the current repository.
 
 ```bash
-# Add to ~/.zshrc:
-eval "$(wt init)"
+wt init
 ```
 
-**The `wtl` function:**
-1. Creates a new worktree (`wt new`)
-2. Changes to the worktree directory
-3. Opens WebStorm
-4. Starts Claude
+**Behavior:**
+- Creates `.wtrc.js` in the main worktree root with default configuration
+- If config already exists, shows a message and exits without overwriting
+
+### `wt doctor`
+
+Check environment and configuration for potential issues.
 
 ```bash
-# Usage:
-wtl feature/my-feature
+wt doctor
 ```
 
+**Checks performed:**
+| Check | Pass | Warn/Fail |
+|-------|------|-----------|
+| Git installed | Shows version | Error |
+| Inside git repo | Shows repo name | Error |
+| GitHub CLI installed | Shows version | Warning with install link |
+| GitHub CLI authenticated | Shows username | Warning to run `gh auth login` |
+| Worktrees directory | Shows count | Info if none yet |
+| Config file | Shows if found | Info if using defaults |
+
+**Example output:**
+```
+Checks:
+  ✓ Git: 2.43.0
+  ✓ Repository: my-repo
+  ✓ GitHub CLI: 2.40.0
+  ✓ GitHub auth: username
+  ✓ Worktrees: 3 worktrees in ../my-repo-worktrees
+  ○ Config: using defaults (no .wtrc.js)
+
+All checks passed!
+```
+
+## Configuration
+
+Create a `.wtrc.js` file in your repository root to configure worktree behavior (or use `wt init`):
+
+```javascript
+export default {
+  worktreePath: '$REPO-worktrees/$DIR',
+  copy: [
+    '.idea/runConfigurations/**',
+    '.idea/codeStyles/**',
+    '!.idea/workspace.xml'
+  ],
+  symlink: [
+    '.env'
+  ],
+  postCreate: 'npm install && code $PATH',
+}
+```
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `worktreePath` | string | `$REPO-worktrees/$DIR` | Path template for new worktrees (relative to parent of main repo) |
+| `copy` | string[] | `[]` | Glob patterns for files to copy from main worktree |
+| `symlink` | string[] | `[]` | Glob patterns for files to symlink from main worktree |
+| `postCreate` | string | `''` | Command to run after creating worktree |
+
+### Template Variables
+
+Use these variables in `worktreePath` and `postCreate`:
+
+| Variable | Description | Example |
+|----------|-------------|---------|
+| `$REPO` | Repository name | `my-repo` |
+| `$BRANCH` | Original branch name | `feature/auth` |
+| `$DIR` | Directory-safe branch name (slashes → dashes) | `feature-auth` |
+| `$PATH` | Full worktree path | `/path/to/my-repo-worktrees/feature-auth` |
+
+### Glob Patterns
+
+Copy and symlink patterns use gitignore-style globs:
+
+- `.env` - single file
+- `.idea/**` - entire directory
+- `!.idea/workspace.xml` - exclude specific file
+- `*.config.js` - wildcard matching
+
+### Post-Create Command
+
+The `postCreate` string runs via `sh -c` in the new worktree directory. Use shell syntax for chaining:
+
+```javascript
+export default {
+  postCreate: 'npm install && code $PATH',
+}
+```
+
+### View Current Config
+
+```bash
+wt config
+```
+
+Shows the active configuration with resolved paths.
+
 ## GitHub Integration
 
 This tool integrates with GitHub to provide rich PR information:
@@ -295,11 +433,15 @@ Here's a typical workflow using these tools:
 
 ```bash
 # Create a new worktree for a feature
-wt feature/add-auth
+wt new feature/add-auth
 
-# Navigate to the worktree
+# Navigate to the worktree (path copied to clipboard)
 cd ../my-repo-worktrees/feature-add-auth
 
+# Or use wt path to get the path
+wt path auth
+# ✓ Copied to clipboard: /path/to/repo-worktrees/feature-add-auth
+
 # Work on your feature...
 git add .
 git commit -m "Add authentication"
@@ -308,6 +450,11 @@ git push -u origin feature/add-auth
 # Create PR via gh CLI
 gh pr create --title "Add authentication" --body "Implements user auth"
 
+# Check status of current worktree
+wt status
+# feature/add-auth (↑1 ↓0)
+# PR #42 open - ✓ checks passing
+
 # Check status of all worktrees
 wt list
 # Shows: feature-add-auth (open)
@@ -317,25 +464,53 @@ wt clean
 # Removes merged worktree and deletes branch
 ```
 
+## Installation
+
+### Via bun
+
+```bash
+bun install -g wt-manager
+```
+
+### Standalone Binaries
+
+Download pre-built binaries from [GitHub Releases](https://github.com/daviddurika/git-worktree-manager/releases):
+
+| Platform | Binary |
+|----------|--------|
+| macOS ARM64 (M1/M2) | `wt-darwin-arm64` |
+| macOS x64 (Intel) | `wt-darwin-x64` |
+| Linux x64 | `wt-linux-x64` |
+| Linux ARM64 | `wt-linux-arm64` |
+| Windows x64 | `wt-windows-x64.exe` |
+
+```bash
+# Example: macOS ARM64
+curl -L https://github.com/daviddurika/git-worktree-manager/releases/latest/download/wt-darwin-arm64 -o ~/.local/bin/wt
+chmod +x ~/.local/bin/wt
+```
+
+Make sure `~/.local/bin` is in your PATH.
+
 ## Development
 
 ### Build
 
 ```bash
-npm run build
+bun run build
 ```
 
 ### Watch Mode
 
 ```bash
-npm run dev
+bun run dev
 ```
 
 ### Linting
 
 ```bash
-npm run lint
-npm run format
+bun run lint
+bun run format
 ```
 
 ## License