skip to content
日替わり OSS
Table of Contents

リポジトリ

Worktrunk とは

Worktrunk は、Git の worktree 機能をより直感的かつ効率的に管理するためのコマンドラインインターフェース(CLI)ツールです。Git の worktree は、単一の Git リポジトリに対して複数の作業ディレクトリ(ワーキングツリー)を作成できる強力な機能であり、複数のブランチやフィーチャーを同時に並行して開発する際に非常に役立ちます。しかし、標準の git worktree コマンドはやや冗長で、使いこなすには習熟が必要です。Worktrunk は、この worktree の操作を、まるで git branch や git checkout を使うかのようにシンプルにすることを目指しています。

特に、近年注目を集める「並列AIエージェントワークフロー」のために設計されている点が特徴です。これは、複数のAIエージェントが同時に異なるタスク(例えば、コードの生成、テストの実行、ドキュメントの更新など)を処理するようなシナリオを想定しています。それぞれのAIエージェントが独立した worktree で作業することで、互いの変更が衝突することなく、効率的に並行作業を進めることが可能になります。

なぜ Worktrunk が必要とされるのか

Git の worktree は素晴らしい機能ですが、そのユーザーエクスペリエンス(UX)は必ずしも最適とは言えません。例えば、新しい worktree を作成して移動するだけでも、複数のコマンドと引数をタイプする必要があります。

従来の Git worktree の課題:

  • 新しい worktree の作成と移動が煩雑。ブランチ名を複数回指定する必要がある。
  • 既存の worktree への移動も、単なる cd コマンドに依存し、worktree の一覧から目的のものを探す手間がある。
  • worktree のクリーンアップ(削除)も、複数のステップが必要で手間がかかる。
  • 複数の worktree を利用する際に、ビルドキャッシュや依存関係のインストールが重複し、ディスク容量の消費やビルド時間の増大につながる可能性がある。

Worktrunk はこれらの課題に対し、洗練されたコマンドセットと豊富な補助機能を提供することで、開発者の負担を大幅に軽減します。

Worktrunk が提供する主要機能とメリット

1. コアコマンドによる操作の簡素化

Worktrunk は、worktree の基本操作をブランチ操作のようにシンプルにします。

  • wt switch <branch_name>: 指定したブランチに対応する worktree に瞬時に移動します。存在しない場合は作成オプションも提供します。
  • wt create <branch_name>: 新しいブランチとそれに対応する worktree を簡単に作成します。
  • wt remove: 現在の worktree とそのブランチを安全に削除します。
  • wt list: 現在のリポジトリの worktree の一覧を表示します。ブランチの状態やCIステータスなども一目で確認できます。

これらのコマンドにより、開発者は worktree の管理に気を取られることなく、本来の開発作業に集中できます。

2. 高度なワークフロー自動化機能

Worktrunk は、単なる worktree 管理に留まらず、開発ワークフロー全体を効率化する多数の高度な機能を提供します。

  • フック (Hooks): worktree の作成時、マージ前、マージ後など、特定のイベント発生時に自動的にコマンドを実行できます。これにより、各 worktree 環境の初期設定や、特定のタスクの自動化が容易になります。
  • LLMコミットメッセージ生成: 変更差分からコミットメッセージを自動生成する機能は、特にAIエージェントによるコード変更や、多数の小さな変更を効率的に管理したい場合に非常に有効です。
  • マージワークフロー: squash、rebase、merge、そしてクリーンアップといった一連のマージ作業を一つのコマンドで実行でき、複雑なマージ戦略を簡素化します。
  • インタラクティブピッカー: worktree を選択する際に、CIステータス、差分、ログ、プルリクエスト情報などをリアルタイムでプレビューしながら選択できるため、目的の worktree へ素早くアクセスできます。
  • ビルドキャッシュの共有 (Copy-on-write build caches): target/ や node_modules/ のようなビルド生成物を、コピーオンライトの仕組みを利用して worktree 間で効率的に共有します。これにより、ディスク容量の節約とビルド時間の短縮が実現され、特にRustやNode.jsのようなビルド時間がかかりがちなプロジェクトで大きなメリットをもたらします(APFS、btrfs、XFSファイルシステムで利用可能)。
  • プルリクエストのチェックアウト: wt switch pr:123 のように入力するだけで、GitHubやGitLabのプルリクエストに対応するブランチを簡単にチェックアウトできます。

これらの機能は、特に多数の並行作業が求められる大規模プロジェクトや、AIエージェントを活用した自律的な開発環境において、開発者の生産性を飛躍的に向上させます。

どんな開発現場で役立つか

Worktrunk は、特に以下のような開発現場でその真価を発揮します。

  • 複数のフィーチャーブランチを並行開発するチーム: 大規模なプロジェクトやモノレポにおいて、複数の開発者がそれぞれ異なる機能開発やバグ修正を同時に進める場合に、worktree をブランチのように手軽に切り替えて作業できます。
  • AIエージェントや自動化ツールを活用する研究・開発チーム: AIエージェントがコード生成やリファクタリングを並行して行う環境で、それぞれのエージェントが独立した作業空間を持つことで、安定した実行と迅速な結果の統合が可能になります。
  • 複雑なワークフローやデプロイ戦略を持つプロジェクト: フック機能やマージワークフローを活用することで、開発環境の初期設定、テスト実行、デプロイ準備といった定型作業を自動化し、ヒューマンエラーのリスクを低減します。
  • 頻繁に異なるプロジェクトやタスクを切り替えるフリーランスやコンサルタント: worktree を活用することで、各プロジェクトやタスクの環境を独立して保ちつつ、少ないディスクスペースで管理できます。

Worktrunk は、Git の worktree の潜在能力を最大限に引き出し、開発者が直面する多くの課題を解決する強力なツールです。Rustで書かれているため、高いパフォーマンスと信頼性も期待できます。

インストール

Homebrew (macOS & Linux) または Cargo を使って簡単にインストールできます。

Terminal window
# Homebrew の場合
brew install worktrunk && wt config shell install
# Cargo の場合
cargo install worktrunk && wt config shell install

wt config shell install を実行することで、コマンドがディレクトリを変更できるようになり、Worktrunk の利便性が最大化されます。

Worktrunk は、現代の開発者が直面する複雑なプロジェクト管理の課題に対し、シンプルかつ強力なソリューションを提供します。ぜひ一度お試しください。