More than 1 year has passed since last update.

Gitリポジトリの一部を指定してclone(ダウンロード)したい場合にdegitが便利

Last updated at 2022-02-25Posted at 2022-02-24

degitとは

degitはGitリポジトリ(またはその一部)をローカル環境にダウンロードするためのCLIツールです。

--depthを使用すれば最新のコミットだけを落とせますし、git clone --filter=blob:none --no-checkoutとgit sparse-checkoutでリポジトリの一部を指定して落とせます。

git clone --depth=1 git@github.com:user/repo.git

git clone --filter=blob:none --no-checkout git@github.com:user/repo.git
cd repo
git sparse-checkout init
git sparse-checkout add subdirectory

ただ後述するように、degitではより短いコマンドで簡単にGitリポジトリの一部を指定してダウンロードできます。

npmでインストールします。

npm install -g degit

GitHubだけでなくGitLab、BitBucket、Sourcehutにも対応しています。

GitHubからリポジトリのmaster(main)ブランチを現在の作業ディレクトリにダウンロードするには以下のようなコマンドを使用します。

degit user/repo

また以下のコマンドはすべて同等です。

degit github:user/repo
degit git@github.com:user/repo
degit https://github.com/user/repo

degit gitlab:user/repo
degit git@gitlab.com:user/repo
degit https://gitlab.com/user/repo

degit bitbucket:user/repo
degit git@bitbucket.org:user/repo
degit https://bitbucket.org/user/repo

degit git.sr.ht:user/repo
degit git@git.sr.ht:user/repo
degit https://git.sr.ht/user/repo

第一引数の末尾にサブディレクトリを追加します。

degit user/repo/subdirectory

省略した場合はデフォルトブランチ(基本的にはmasterまたはmain)になります。

degit user/repo#dev       # branch
degit user/repo#v1.2.3    # release tag
degit user/repo#1234abcd  # commit hash

省略した場合は現在のディレクトリにダウンロードします。

degit user/repo my-new-project

このリポジトリのmainブランチのclient/android以下が欲しいとします。

以下のコマンドで保存場所をmy-folderに指定して落とすことができます。

degit derrickstolee/sparse-checkout-example/client/android my-folder
cd my-folder