@kianax/wt 0.1.4 → 0.1.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kiana
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,57 +1,102 @@
 # wt - Git Worktree Manager
 
-A fast, simple CLI for managing git worktrees.
+A fast, interactive TUI for managing git worktrees. Makes worktrees as effortless as branches.
 
 ## Install
 
 ```bash
-# npm
 npm install -g @kianax/wt
+```
+
+Or build from source (requires [Bun](https://bun.sh)):
 
-# Or build from source (requires Bun)
+```bash
 bun install && bun run build
 cp wt /usr/local/bin/
 ```
 
-## Setup
+## Shell Integration
+
+Shell integration enables `wt` to change your working directory when selecting a worktree. Without it, selections just print the path.
 
-Add shell integration to your `.bashrc` or `.zshrc`:
+**Bash/Zsh** - add to `~/.bashrc` or `~/.zshrc`:
 
 ```bash
 eval "$(wt shell-init bash)"   # or zsh
 ```
 
-For fish, add to `~/.config/fish/config.fish`:
+**Fish** - add to `~/.config/fish/config.fish`:
 
 ```fish
 wt shell-init fish | source
 ```
 
+The TUI will prompt you to set this up on first run.
+
 ## Usage
 
 ```bash
-wt              # Open interactive TUI
-wt new feature  # Create new worktree
-wt cd feature   # Switch to worktree
-wt rm feature   # Remove worktree
-wt list         # List all worktrees
-wt current      # Show current worktree name
+wt                    # Open interactive TUI
+wt new <name>         # Create new worktree
+wt cd <name>          # Switch to worktree (requires shell integration)
+wt rm <name>          # Remove worktree
+wt mv <old> <new>     # Rename worktree
+wt ls                 # List all worktrees
+wt current            # Show current worktree name
+```
+
+### Command Options
+
+```bash
+# Create with options
+wt new feature --base main        # Branch from specific base
+wt new feature --branch feat/foo  # Custom branch name
+wt new feature --detach           # Detached HEAD (no branch)
+
+# Remove with options
+wt rm feature --force             # Force remove even if dirty
+wt rm feature --delete-branch     # Also delete the branch
+
+# List with options
+wt ls --json                      # JSON output
+wt ls --porcelain                 # Machine-readable format
+
+# Current worktree info
+wt current --path                 # Full path
+wt current --branch               # Branch name
 ```
 
-### TUI Keybindings
+## TUI Keybindings
 
 | Key | Action |
 |-----|--------|
-| `j/k` or arrows | Navigate |
-| `Enter` | Switch to worktree |
+| `j/k` or `↑/↓` | Navigate |
+| `Enter` | Select worktree |
 | `n` | New worktree |
 | `d` | Delete worktree |
 | `r` | Rename worktree |
+| `i` | Show details |
 | `q` | Quit |
 
+## Status Indicators
+
+The TUI shows status for each worktree:
+
+| Status | Meaning |
+|--------|---------|
+| `dirty` | Uncommitted changes |
+| `ahead` | Commits to push |
+| `behind` | Commits to pull |
+| `diverged` | Both ahead and behind |
+| `synced` | Clean and up-to-date |
+| `merged` | Branch merged, can be cleaned up |
+| `stale` | No commits in 30+ days |
+
+Sync indicators show commit counts: `+3` (ahead) `-2` (behind)
+
 ## How It Works
 
-Worktrees are stored in `~/.worktrees/<repo-id>/` by default. Each worktree gets its own directory with a branch of the same name.
+Worktrees are stored in `~/.worktrees/<repo-id>/` by default:
 
 ```
 ~/.worktrees/
@@ -60,19 +105,27 @@ Worktrees are stored in `~/.worktrees/<repo-id>/` by default. Each worktree gets
     bugfix-login/
 ```
 
+The repo ID is derived from your git remote URL (e.g., `github.com-user-repo`).
+
 ## Configuration
 
-Create `~/.config/wt/config.json` for global settings:
+All configuration is in `~/.config/wt/config.json`:
 
 ```json
 {
   "defaults": {
-    "branchPrefix": "feature/"
+    "branchPrefix": "feature/",
+    "staleDays": 30
+  },
+  "repos": {
+    "github.com-user-repo": {
+      "branchPrefix": "feat/"
+    }
   }
 }
 ```
 
-Or `.wtrc.json` in your repo for per-project settings.
+Use `repos` to override settings for specific repositories (keyed by repo ID).
 
 ## License