easy-worktree 0.0.5__tar.gz → 0.1.0__tar.gz

{easy_worktree-0.0.5 → easy_worktree-0.1.0}/.gitignore

@@ -11,3 +11,5 @@ wheels/
 
 # Worktree directories
 WT_*/
+.pytest_cache
+tmp/*

easy_worktree-0.1.0/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.4
+Name: easy-worktree
+Version: 0.1.0
+Summary: Git worktree を簡単に管理するための CLI ツール
+Project-URL: Homepage, https://github.com/igtm/easy-worktree
+Project-URL: Repository, https://github.com/igtm/easy-worktree
+Project-URL: Issues, https://github.com/igtm/easy-worktree/issues
+Author: igtm
+License: MIT
+License-File: LICENSE
+Keywords: cli,git,tool,worktree
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Requires-Dist: toml
+Description-Content-Type: text/markdown
+
+![hero](hero.png)
+
+# easy-worktree
+
+A CLI tool for easy Git worktree management.
+
+[日本語版 README](README_ja.md)
+
+## Overview
+
+`easy-worktree` simplifies git worktree management.
+It keeps the root of your git repository as your primary working area (main), while managing other worktrees in a subdirectory (default: `.worktrees/`).
+
+### Key Features
+
+- **Standardized directory structure**: Worktrees are created in a `.worktrees/` subdirectory (configurable). Keeps your root directory clean.
+- **Auto Sync**: Automatically sync files ignored by git (like `.env`) from the root to each worktree.
+- **Clear Status**: `wt list` shows worktree branches, their status (clean/dirty), and associated GitHub PRs in a beautiful table.
+- **Smart Cleanup**: Easily batch remove merged branches or old unused worktrees.
+- **Two-letter shortcuts**: Fast execution with shortcuts like `ad`, `ls`, `st`, `sy`, `cl`.
+
+## Prerequisites
+
+`easy-worktree` requires the following:
+
+- **Git**: 2.34 or higher recommended.
+- **GitHub CLI (gh)**: Required for PR features (`wt list --pr`, `wt pr add`, `wt clean --merged`). [Installation guide](https://cli.github.com/).
+
+## Installation
+
+```bash
+pip install easy-worktree
+```
+
+Or install the development version:
+
+```bash
+git clone https://github.com/igtm/easy-worktree.git
+cd easy-worktree
+pip install -e .
+```
+
+## Usage
+
+### Getting Started
+
+#### Clone a new repository
+
+```bash
+wt clone https://github.com/user/repo.git
+```
+
+This clones the repository and initializes `easy-worktree` configuration.
+
+#### Initialize an existing repository
+
+```bash
+cd my-repo/
+wt init
+```
+
+Initializes `easy-worktree` in the current repository. Your main repository stays at the project root.
+
+### Managing Worktrees
+
+#### Add a worktree (shortcut: `ad`)
+
+```bash
+wt add feature-1
+```
+
+This creates the following structure:
+
+```
+my-repo/ (main)
+  .worktrees/
+    feature-1/  # Your new worktree
+  .wt/
+  ...
+```
+
+You can also specify a base branch:
+
+```bash
+wt add feature-1 main
+```
+
+#### List worktrees
+
+```bash
+wt list
+wt list --pr  # Show PR information
+```
+
+
+#### Stash and Move (shortcut: `st`)
+
+Quickly stash your current changes and move them to a new worktree.
+
+```bash
+wt stash feature-2
+```
+
+#### PR Management
+
+Fetch a PR and create a worktree for it. (Requires `gh` CLI)
+
+```bash
+wt pr add 123    # Fetches PR #123 and creates 'pr@123' worktree
+```
+
+#### Remove a worktree
+
+```bash
+wt rm feature-1
+```
+
+Removes the worktree and its directory.
+
+### Useful Features
+
+#### Sync configuration files (shortcut: `sy`)
+
+Sync files like `.env` that are not in git from the root to your worktrees.
+
+```bash
+wt sync .env
+```
+
+
+#### Cleanup (shortcut: `cl`)
+
+```bash
+wt clean --merged
+wt clean --closed  # Remove worktrees for closed (unmerged) PRs
+wt clean --days 30
+```
+
+
+
+### Configuration
+
+Customize behavior in `.wt/config.toml`:
+
+```toml
+worktrees_dir = ".worktrees"   # Directory where worktrees are created
+sync_files = [".env"]          # Files to auto-sync
+auto_copy_on_add = true         # Enable auto-sync on add
+```
+
+## Hooks
+
+You can define scripts to run automatically after `wt add`.
+Templates are created in `.wt/post-add` upon initialization.
+
+## License
+
+MIT License

easy_worktree-0.1.0/README.md

@@ -0,0 +1,158 @@
+![hero](hero.png)
+
+# easy-worktree
+
+A CLI tool for easy Git worktree management.
+
+[日本語版 README](README_ja.md)
+
+## Overview
+
+`easy-worktree` simplifies git worktree management.
+It keeps the root of your git repository as your primary working area (main), while managing other worktrees in a subdirectory (default: `.worktrees/`).
+
+### Key Features
+
+- **Standardized directory structure**: Worktrees are created in a `.worktrees/` subdirectory (configurable). Keeps your root directory clean.
+- **Auto Sync**: Automatically sync files ignored by git (like `.env`) from the root to each worktree.
+- **Clear Status**: `wt list` shows worktree branches, their status (clean/dirty), and associated GitHub PRs in a beautiful table.
+- **Smart Cleanup**: Easily batch remove merged branches or old unused worktrees.
+- **Two-letter shortcuts**: Fast execution with shortcuts like `ad`, `ls`, `st`, `sy`, `cl`.
+
+## Prerequisites
+
+`easy-worktree` requires the following:
+
+- **Git**: 2.34 or higher recommended.
+- **GitHub CLI (gh)**: Required for PR features (`wt list --pr`, `wt pr add`, `wt clean --merged`). [Installation guide](https://cli.github.com/).
+
+## Installation
+
+```bash
+pip install easy-worktree
+```
+
+Or install the development version:
+
+```bash
+git clone https://github.com/igtm/easy-worktree.git
+cd easy-worktree
+pip install -e .
+```
+
+## Usage
+
+### Getting Started
+
+#### Clone a new repository
+
+```bash
+wt clone https://github.com/user/repo.git
+```
+
+This clones the repository and initializes `easy-worktree` configuration.
+
+#### Initialize an existing repository
+
+```bash
+cd my-repo/
+wt init
+```
+
+Initializes `easy-worktree` in the current repository. Your main repository stays at the project root.
+
+### Managing Worktrees
+
+#### Add a worktree (shortcut: `ad`)
+
+```bash
+wt add feature-1
+```
+
+This creates the following structure:
+
+```
+my-repo/ (main)
+  .worktrees/
+    feature-1/  # Your new worktree
+  .wt/
+  ...
+```
+
+You can also specify a base branch:
+
+```bash
+wt add feature-1 main
+```
+
+#### List worktrees
+
+```bash
+wt list
+wt list --pr  # Show PR information
+```
+
+
+#### Stash and Move (shortcut: `st`)
+
+Quickly stash your current changes and move them to a new worktree.
+
+```bash
+wt stash feature-2
+```
+
+#### PR Management
+
+Fetch a PR and create a worktree for it. (Requires `gh` CLI)
+
+```bash
+wt pr add 123    # Fetches PR #123 and creates 'pr@123' worktree
+```
+
+#### Remove a worktree
+
+```bash
+wt rm feature-1
+```
+
+Removes the worktree and its directory.
+
+### Useful Features
+
+#### Sync configuration files (shortcut: `sy`)
+
+Sync files like `.env` that are not in git from the root to your worktrees.
+
+```bash
+wt sync .env
+```
+
+
+#### Cleanup (shortcut: `cl`)
+
+```bash
+wt clean --merged
+wt clean --closed  # Remove worktrees for closed (unmerged) PRs
+wt clean --days 30
+```
+
+
+
+### Configuration
+
+Customize behavior in `.wt/config.toml`:
+
+```toml
+worktrees_dir = ".worktrees"   # Directory where worktrees are created
+sync_files = [".env"]          # Files to auto-sync
+auto_copy_on_add = true         # Enable auto-sync on add
+```
+
+## Hooks
+
+You can define scripts to run automatically after `wt add`.
+Templates are created in `.wt/post-add` upon initialization.
+
+## License
+
+MIT License

easy_worktree-0.1.0/README_ja.md

@@ -0,0 +1,155 @@
+![hero](hero.png)
+
+# easy-worktree
+
+Git worktree を簡単に管理するための CLI ツール
+
+## 概要
+
+`easy-worktree` は git worktree の管理をシンプルにするためのツールです。
+リポジトリのルートディレクトリをそのままメインの作業場所（main）として使いつつ、他のブランチでの作業が必要な場合はサブディレクトリ（デフォルトでは `.worktrees/`）に worktree を作成して管理します。
+
+### 主な特徴
+
+- **整理されたディレクトリ構成**: worktree は `.worktrees/` ディレクトリ（設定で変更可能）の下に作成されます。ルートディレクトリが散らかりません。
+- **自動同期**: `.env` などの git 管理外ファイルを、ルートから各 worktree へ自動的にコピー・同期できます。
+- **わかりやすい一覧表示**: `wt list` で worktree の一覧、ブランチ、状態（clean/dirty）、GitHub PR 情報を美しく表示します。
+- **スマートなクリーンアップ**: マージ済みのブランチや古い worktree を簡単に削除できるようになります。
+- **2文字ショートカット**: `ad`, `ls`, `st`, `sy`, `cl` といった短いコマンドで素早く操作できます。
+
+## 前提条件
+
+`easy-worktree` には以下が必要です：
+
+- **Git**: 2.34 以上を推奨します。
+- **GitHub CLI (gh)**: PR 関連機能（`wt list --pr`, `wt pr add`, `wt clean --merged`）を利用する場合に必要です。[インストール方法](https://cli.github.com/)。
+
+## インストール
+
+```bash
+pip install easy-worktree
+```
+
+または開発版をインストール:
+
+```bash
+git clone https://github.com/igtm/easy-worktree.git
+cd easy-worktree
+pip install -e .
+```
+
+## 使い方
+
+### リポジトリの準備
+
+#### 新しくクローンする場合
+
+```bash
+wt clone https://github.com/user/repo.git
+```
+
+リポジトリをクローンし、`easy-worktree` 用の初期設定を自動で行います。
+
+#### 既存のリポジトリで使い始める場合
+
+```bash
+cd my-repo/
+wt init
+```
+
+現在のディレクトリをメインリポジトリ（ルート）として `easy-worktree` を初期化します。既存のリポジトリ構成はそのまま維持されます。
+
+### worktree の操作
+
+#### worktree を追加 (ショートカット: `ad`)
+
+```bash
+wt add feature-1
+```
+
+これにより、以下のディレクトリ構成が作成されます：
+
+```
+my-repo/ (main)
+  .worktrees/
+    feature-1/  # ここが新しい worktree
+  .wt/
+  ...
+```
+
+既存のブランチを指定して作成することもできます：
+
+```bash
+wt add feature-1 main
+```
+
+#### 一覧を表示 (ショートカット: `ls`)
+
+```bash
+wt list
+wt ls --pr   # GitHub の PR 情報もあわせて表示
+```
+
+
+#### スタッシュと移動 (ショートカット: `st`)
+
+現在の変更をスタッシュし、そのまま新しい worktree を作成して移動します。
+
+```bash
+wt stash feature-2
+```
+
+#### PR 管理
+
+GitHub の PR を取得して worktree を作成します（`gh` CLI が必要です）。
+
+```bash
+wt pr add 123    # PR #123 を取得し 'pr@123' という名前で worktree を作成
+```
+
+#### 削除
+
+```bash
+wt rm feature-1
+```
+
+ディレクトリごと worktree を削除します。
+
+### 便利な機能
+
+#### 設定ファイルの同期 (ショートカット: `sy`)
+
+`.env` ファイルなどの git 管理外ファイルを、ルートから worktree に手動で同期します。
+
+```bash
+wt sync .env
+```
+
+
+#### クリーンアップ (ショートカット: `cl`)
+
+```bash
+wt clean --merged
+wt clean --closed  # クローズされた (未マージ) PRのworktreeを削除
+wt clean --days 30
+```
+
+
+### 設定
+
+`.wt/config.toml` で挙動をカスタマイズできます：
+
+```toml
+worktrees_dir = ".worktrees"   # worktree を作成するディレクトリ名
+sync_files = [".env"]          # 自動同期するファイル一覧
+auto_copy_on_add = true        # wt add 時にファイルを自動コピーするか
+```
+
+## Hook
+
+`wt add` の後に自動実行されるスクリプトを記述できます。
+テンプレートが `.wt/post-add` に作成されます。
+
+## ライセンス
+
+MIT License