vde-worktree 0.0.4 → 0.0.6

package/README.ja.md

@@ -3,6 +3,7 @@
 `vde-worktree` は、人間とコーディングエージェントの両方を想定した、安全な Git worktree 管理 CLI です。
 
 利用できるコマンド名:
+
 - `vde-worktree`
 - `vw`（エイリアス）
 
@@ -122,6 +123,7 @@ vw init
 ```
 
 機能:
+
 - `.worktree/` と `.vde/worktree/*` を作成
 - `.git/info/exclude` に管理エントリ追加
 - デフォルト hook テンプレートを作成
@@ -134,8 +136,10 @@ vw list --json
 ```
 
 機能:
+
 - Git の porcelain 情報から worktree 一覧を取得
 - branch/path/dirty/lock/merged/upstream を表示
+- 対話ターミナルでは Catppuccin 風の ANSI 色で表示
 
 ### `status`
 
@@ -146,6 +150,7 @@ vw status --json
 ```
 
 機能:
+
 - 対象 worktree 1件の状態を表示
 - branch 指定なしなら現在 `cwd` から該当 worktree を解決
 
@@ -157,6 +162,7 @@ vw path feature/foo --json
 ```
 
 機能:
+
 - 指定 branch の絶対 worktree path を返す
 
 ### `new`
@@ -167,6 +173,7 @@ vw new feature/foo
 ```
 
 機能:
+
 - 新しい branch + worktree を `.worktree/` に作成
 - branch 省略時は `wip-xxxxxx` を自動生成
 
@@ -177,6 +184,7 @@ vw switch feature/foo
 ```
 
 機能:
+
 - 指定 branch の worktree があれば再利用、なければ作成
 - 冪等な branch 入口コマンド
 
@@ -187,6 +195,7 @@ vw mv feature/new-name
 ```
 
 機能:
+
 - 現在の非primary worktree の branch 名と path をリネーム
 - detached HEAD では実行不可
 
@@ -199,10 +208,12 @@ vw del feature/foo --force-unmerged --allow-unpushed --allow-unsafe
 ```
 
 機能:
+
 - worktree と branch を安全に削除
 - デフォルトで dirty / locked / unmerged(unknown含む) / unpushed(unknown含む) を拒否
 
 主な解除フラグ:
+
 - `--force-dirty`
 - `--allow-unpushed`
 - `--force-unmerged`
@@ -218,6 +229,7 @@ vw gone --json
 ```
 
 機能:
+
 - 一括クリーンアップ候補の抽出/削除
 - デフォルトは dry-run
 - `--apply` で削除実行
@@ -229,6 +241,7 @@ vw get origin/feature/foo
 ```
 
 機能:
+
 - remote branch を fetch
 - ローカル追跡 branch がなければ作成
 - worktree を作成/再利用
@@ -241,11 +254,13 @@ vw extract --current --stash
 ```
 
 機能:
+
 - primary worktree の現在 branch を `.worktree/` 側へ切り出し
 - primary を base branch に戻す
 - dirty 状態で切り出す場合は `--stash` を使用
 
 現状の制約:
+
 - 実装は primary worktree の抽出フローが中心
 
 ### `use`
@@ -256,10 +271,12 @@ vw use feature/foo --allow-agent --allow-unsafe
 ```
 
 機能:
+
 - primary worktree を指定 branch に checkout
 - primary context を固定したい用途向け
 
 安全条件:
+
 - primary が dirty なら拒否
 - 非TTYでは `--allow-agent` と `--allow-unsafe` の両方が必要
 
@@ -271,10 +288,12 @@ vw exec feature/foo --json -- pnpm test
 ```
 
 機能:
+
 - 指定 branch の worktree を `cwd` にしてコマンド実行
 - shell 展開は使わず引数配列で実行
 
 終了コード:
+
 - 子プロセス成功: `0`
 - 子プロセス失敗: `21`（JSON では `CHILD_PROCESS_FAILED`）
 
@@ -286,6 +305,7 @@ vw invoke pre-new -- --arg1 --arg2
 ```
 
 機能:
+
 - `pre-*` / `post-*` hook を手動実行
 - hook デバッグ用
 
@@ -296,6 +316,7 @@ vw copy .envrc .claude/settings.local.json
 ```
 
 機能:
+
 - repo 相対パスのファイル/ディレクトリを target worktree にコピー
 - 主に hook 内で `WT_WORKTREE_PATH` と合わせて使う想定
 
@@ -307,6 +328,7 @@ vw link .envrc --no-fallback
 ```
 
 機能:
+
 - target worktree 側に symlink を作成
 - Windows では `--no-fallback` がない場合、copy にフォールバック可
 
@@ -319,6 +341,7 @@ vw unlock feature/foo --force
 ```
 
 機能:
+
 - `lock`: `.vde/worktree/locks/` に lock 情報を保存
 - `unlock`: lock を解除（owner 不一致時は `--force` 必須）
 
@@ -329,7 +352,11 @@ cd "$(vw cd)"
 ```
 
 機能:
+
 - `fzf` で worktree を対話選択
+- Picker では worktree の branch 名 + 最小 state（dirty / merged / lock）を表示
+- preview で path と states（dirty / locked / merged / upstream）を表示
+- 対話ターミナルでは Picker/preview を Catppuccin 風 ANSI 色で表示
 - 選択した絶対 path を stdout に出力
 
 ### `completion`
@@ -341,6 +368,7 @@ vw completion zsh --install
 ```
 
 機能:
+
 - zsh / fish 向け補完スクリプトを出力
 - `--install` 指定時はデフォルトまたは `--path` に補完ファイルを書き込む
 
@@ -359,6 +387,7 @@ vw completion zsh --install
 - `byPR === null` -> `byAncestry` にフォールバック
 
 `byPR` が `null` になる例:
+
 - `gh` 未導入
 - `gh auth` 未設定
 - API 失敗
@@ -369,12 +398,14 @@ vw completion zsh --install
 `--json` 指定時、stdout は常に単一 JSON オブジェクトです。
 
 共通成功フィールド:
+
 - `schemaVersion`
 - `command`
 - `status`
 - `repoRoot`
 
 エラー時:
+
 - `status: "error"`
 - `code`
 - `message`

package/README.md

@@ -3,6 +3,7 @@
 `vde-worktree` is a safe Git worktree manager designed for both humans and coding agents.
 
 It installs two command names:
+
 - `vde-worktree`
 - `vw` (alias)
 
@@ -122,6 +123,7 @@ vw init
 ```
 
 What it does:
+
 - Creates `.worktree/` and `.vde/worktree/*`
 - Appends managed entries to `.git/info/exclude`
 - Creates default hook templates
@@ -134,8 +136,10 @@ vw list --json
 ```
 
 What it does:
+
 - Lists all worktrees from Git porcelain output
 - Includes metadata such as branch, path, dirty, lock, merged, and upstream status
+- In interactive terminal, uses Catppuccin-style ANSI colors
 
 ### `status`
 
@@ -146,6 +150,7 @@ vw status --json
 ```
 
 What it does:
+
 - Shows one worktree state
 - Without branch argument, resolves current worktree from current `cwd`
 
@@ -157,6 +162,7 @@ vw path feature/foo --json
 ```
 
 What it does:
+
 - Resolves and returns the absolute worktree path for the target branch
 
 ### `new`
@@ -167,6 +173,7 @@ vw new feature/foo
 ```
 
 What it does:
+
 - Creates a new branch + worktree under `.worktree/`
 - Without argument, generates `wip-xxxxxx`
 
@@ -177,6 +184,7 @@ vw switch feature/foo
 ```
 
 What it does:
+
 - Idempotent branch entrypoint
 - Reuses existing worktree if present, otherwise creates one
 
@@ -187,6 +195,7 @@ vw mv feature/new-name
 ```
 
 What it does:
+
 - Renames current non-primary worktree branch and moves its directory
 - Requires branch checkout (not detached HEAD)
 
@@ -199,10 +208,12 @@ vw del feature/foo --force-unmerged --allow-unpushed --allow-unsafe
 ```
 
 What it does:
+
 - Removes worktree and branch safely
 - By default, rejects dirty, locked, unmerged/unknown, or unpushed/unknown states
 
 Useful force flags:
+
 - `--force-dirty`
 - `--allow-unpushed`
 - `--force-unmerged`
@@ -218,6 +229,7 @@ vw gone --json
 ```
 
 What it does:
+
 - Bulk cleanup candidate finder/remover
 - Default mode is dry-run
 - `--apply` actually deletes eligible branches/worktrees
@@ -229,6 +241,7 @@ vw get origin/feature/foo
 ```
 
 What it does:
+
 - Fetches remote branch
 - Creates tracking local branch when missing
 - Creates/reuses local worktree
@@ -241,11 +254,13 @@ vw extract --current --stash
 ```
 
 What it does:
+
 - Extracts current primary worktree branch into `.worktree/`
 - Switches primary worktree back to base branch
 - `--stash` allows extraction when primary is dirty
 
 Current limitation:
+
 - Implementation currently supports primary worktree extraction flow.
 
 ### `use`
@@ -256,10 +271,12 @@ vw use feature/foo --allow-agent --allow-unsafe
 ```
 
 What it does:
+
 - Checks out the target branch in the primary worktree
 - Intended for human workflows where primary context must be fixed
 
 Safety:
+
 - Rejects dirty primary worktree
 - In non-TTY mode, requires `--allow-agent` and `--allow-unsafe`
 
@@ -271,10 +288,12 @@ vw exec feature/foo --json -- pnpm test
 ```
 
 What it does:
+
 - Executes command inside the target branch worktree path
 - Does not use shell expansion
 
 Exit behavior:
+
 - Child success => `0`
 - Child failure => `21` (`CHILD_PROCESS_FAILED` in JSON mode)
 
@@ -286,6 +305,7 @@ vw invoke pre-new -- --arg1 --arg2
 ```
 
 What it does:
+
 - Manually invokes `pre-*` / `post-*` hook scripts
 - Useful for debugging hook behavior
 
@@ -296,6 +316,7 @@ vw copy .envrc .claude/settings.local.json
 ```
 
 What it does:
+
 - Copies repo-relative files/dirs from repo root into target worktree
 - Primarily intended for hook usage with `WT_WORKTREE_PATH`
 
@@ -307,6 +328,7 @@ vw link .envrc --no-fallback
 ```
 
 What it does:
+
 - Creates symlink in target worktree pointing to repo-root file
 - On Windows, can fallback to copy unless `--no-fallback`
 
@@ -319,6 +341,7 @@ vw unlock feature/foo --force
 ```
 
 What they do:
+
 - `lock` writes lock metadata under `.vde/worktree/locks/`
 - `unlock` clears lock, enforcing owner match unless `--force`
 
@@ -329,7 +352,11 @@ cd "$(vw cd)"
 ```
 
 What it does:
+
 - Interactive worktree picker via `fzf`
+- Picker list shows worktree branch names with minimal states (dirty/merged/lock)
+- Preview pane shows path and worktree states (dirty/locked/merged/upstream)
+- Picker and preview use Catppuccin-style ANSI colors in interactive terminal
 - Prints selected absolute path to stdout
 
 ### `completion`
@@ -341,6 +368,7 @@ vw completion zsh --install
 ```
 
 What it does:
+
 - Prints completion script for zsh/fish
 - With `--install`, writes completion file to shell default path or `--path`
 
@@ -365,12 +393,14 @@ Overall policy:
 With `--json`, stdout always emits exactly one JSON object.
 
 Common success fields:
+
 - `schemaVersion`
 - `command`
 - `status`
 - `repoRoot`
 
 Error shape:
+
 - `status: "error"`
 - `code`
 - `message`