Sproutは、ローカルファイルを対象とするスナップショット型のバージョン管理CLIです。 指定した複数のファイルをコミット単位で保存し、任意のコミットへの復元とブランチによる履歴の分岐を提供します。 管理データはローカルディスク内に保存され、ネットワーク通信を必要としません。
- 複数のファイルをまとめて1つのコミットとして保存
- 過去のコミットをいつでも復元
- ブランチを使って作業を分岐
- 同じ内容のファイルは重複して保存しない
- 未コミットの変更や未追跡ファイルを保護
- オフラインで完結
Sproutはファイルの差分ではなく、その時点のファイル構成をスナップショットとして記録します。
Python 3.12以降が必要です。uvを利用すると、次のコマンドで開発環境を準備できます。
uv sync --dev
uv run sprout --help通常のコマンドとしてインストールする場合は、プロジェクトのルートで次を実行します。
uv tool install .
sprout --helpまず、管理したいフォルダへ移動してSproutを初期化します。
sprout init次に、保存したいファイルやフォルダを追跡対象へ登録します。フォルダを指定した場合は、その中にあるファイルがまとめて登録されます。
sprout track document.bin references
sprout status作業の区切りでコミットを作成します。
sprout commit -m "最初のスナップショット"保存した履歴は、次のコマンドで確認できます。
sprout log
sprout log scene.blend
sprout show <commit-id>sprout log にパスを指定すると、そのファイル内容が変わったコミットだけを表示します。内容が同じままのコミットは省かれます。一度も登場していないパスでは No history for path: と表示されます。
現在の状態から別の作業を試したいときは、ブランチを作成します。 ブランチは最初のコミット後に作成できます。
sprout branch experiment -m "別の方法を試す"
sprout switch experimentブランチの一覧はsprout branchで確認できます。先頭に*が付いているものが現在のブランチです。
* main a12bc34de567
experiment b98fe76dc543 # 別の方法を試す
ブランチを切り替える場合はswitch、特定のコミットを作業フォルダへ復元する場合はrestoreを使います。
sprout switch main
sprout restore <commit-id>復元や切り替えの前に、ファイル単位の差分だけ確認したい場合はdiffを使います。
# HEAD と作業ツリー
sprout diff
# 指定コミットと作業ツリー
sprout diff <commit-id>
# コミット間（A から B）
sprout diff <commit-a> <commit-b>特定のファイルだけ昔の版に戻す場合は、コミットのあとにパスを指定します。ディレクトリを指定すると、そのコミット内の配下ファイルがまとめて復元されます。部分復元ではブランチ先端や、指定していない追跡ファイルの状態は変わりません。
sprout restore <commit-id> docs/manual.bin
sprout restore <commit-id> assets/未保存の変更がある場合、Sproutはファイルを保護するため処理を中止します。
変更を破棄してよい場合に限り、--discardを指定してください。
部分復元では、復元対象のパスに未保存変更があるときだけ--discardが必要です。
sprout switch main --discard--discardは、新たに追跡したファイルや移動したファイルを含む、追跡済みファイルのすべての未コミット変更を破棄します。
未追跡ファイルを削除したり上書きしたりすることはなく、復元先のパスと未追跡ファイルが衝突する場合は処理を中止します。
作業フォルダが保存済みコミットの内容そのものなら、別のコミットやブランチへ戻るときに--discardは不要です。
古いコミットを確認したあと現在のブランチの最新状態に戻るには、ブランチ名を指定して復元します。
sprout restore main# 変更された追跡ファイルを表示
sprout status
# 特定のファイルが追跡されているか確認
sprout status document.bin
# 追跡済み、未追跡のファイルを一覧表示
sprout status --tracked
sprout status --untrackedファイルの追跡をやめる場合はuntrackを使用します。作業フォルダのファイル自体は削除されません。
sprout untrack document.bin追跡済みファイルの名前や場所を変える場合はmoveを使用します。
作業フォルダのファイルを移動し、追跡パスも更新します。
sprout move document.bin archive/document.bin
sprout commit -m "ファイルを移動"statusとcommitはファイル内容で変更を判定します。
内容が同じで更新時刻だけが変わったファイルは、変更なしとして扱われます。
履歴は、初期化したフォルダ内の.sproutへ保存されます。バックアップや別のディスクへ移動するときは、.sproutを含めてフォルダ全体をコピーしてください。
.sproutの内容は手動で編集しないでください。処理が途中で中断された場合は、次回のSprout起動時に可能な範囲で自動的に復旧します。
| コマンド | 説明 |
|---|---|
init [PATH] |
Sproutの管理情報を作成する |
track PATH... |
ファイルを追跡対象へ登録する |
untrack PATH... |
ファイルの追跡をやめる |
move OLD NEW |
追跡済みファイルを移動する |
status |
現在の変更や追跡状態を確認する |
commit -m MESSAGE |
現在の状態をコミットする |
log [PATH] |
現在のブランチの履歴を表示する。パスを指定するとそのファイルが変わったコミットだけを表示する |
diff [COMMIT_A] [COMMIT_B] |
コミット間、または作業ツリーとのファイル差分を表示する |
show COMMIT |
コミットの詳細を表示する |
branch [NAME] |
ブランチの一覧表示または作成を行う |
switch BRANCH |
別のブランチへ切り替える |
restore COMMIT [PATH...] |
指定したコミットを復元する。パスを指定するとそのファイルだけ復元する |
gc [--dry-run] |
どのコミットからも参照されないオブジェクトを削除する |
doctor |
リポジトリの整合性（欠落・破損オブジェクトなど）を検査する |
stats |
リポジトリの件数・容量と重複排除による節約量を表示する |
コミットの指定には、完全なコミットID、一意に識別できるIDの先頭部分、またはブランチ名を使用できます。
gcは参照されないオブジェクトと、中断などで残った一時ファイル(object-*)を削除します。削除前に対象だけ確認したい場合は--dry-runを使います。
リポジトリの健全性だけ確認したい場合はdoctorを使います。参照されているオブジェクトの欠落・内容破損、中断中の操作記録、残った一時ファイルを報告します。問題がなければOKを表示し、問題があれば終了コード1で終了します。作業ツリーや追跡状態は変更しません。
容量と重複排除の効果を確認したい場合はstatsを使います。objectsの件数・合計サイズ、コミット数、追跡パス数に加え、コミット上の論理サイズと実ユニークサイズの差（Dedup saved）を表示します。読み取り専用です。
プロジェクトルートの.sproutignoreに、追跡したくないファイルのパターンを書けます。書式は次のとおりです。
- 1行に1パターン
#で始まる行はコメント*などの glob はパス全体とファイル名の両方に照合する（例:*.tmp、Thumbs.db）- 末尾が
/のパターンはディレクトリとその配下を除外する（例:cache/）
適用されるのは次の操作だけです。
- ディレクトリを指定した
track（配下を走査するとき） status --untrackedの一覧
ファイルを明示して track した場合は、無視パターンより優先して登録されます。すでに追跡中のファイルの変更検出（status の added / modified / deleted）には影響しません。.sproutignore 自体も通常のファイルとして追跡できます。
最初のリリースでは、リモート同期、マージ、タグ、GUIには対応していません。
大きなファイルを頻繁に更新すると、.sprout/objectsの使用量は増えますが、不要になったオブジェクトはgcで削除できます。
uv run pytestSproutはMIT Licenseのもとで公開されています。