Retrospectively add --recursive to a git repo

Question

If you git clone with --recursive, you can get all the git submodules too.

If I've forgotten to add this magical flag when cloning, as can happen, how do I now go and get any submodules?

Additionally, how can I set the recursive flag as a default for future clones?

Solution 1

You can do it with this after a simple top-level clone:

git submodule update --init --recursive

I would not recommend making clone do this by default. The proper way to do this if you are using submodules aggressively for development and not just linking to 3rd party OSS libs on github that you may upgrade once in a blue moon, is to use git slave or subtree.

Hope this helps.

Solution 2

1. From the root of your repo:

   $ git submodule update --init --recursive
   

   That will update any and all registered submodules, initializing them if need be to the value as found in the .gitmodules file, and also recurse into complex submodules (ones with submodules of their own) and initialize and update them as well.

2. The easiest way I know of to make cloning recursively the default would be to shadow git clone with an alias

   $ git config --global alias.clone = 'clone --recursive'
   

   As far as adding options always, I think that's the idiomatic method.

Solution 3

IIRC, git submodule init, git submodule update

Unfortunately, I do not see an option to enable recursive by default, however.

Comments

[Abizern]

You could always create a shell or git alias that performs a recursive clone. However, it may seem harder to do it in two steps here, but this way you can change the urls of the submodule repositories in the config file after the init but before the update. You need to do this for some repositories where the submodules have been set up with the url for the private repository and you need to change these to the public urls.

[Abizern]

Rather than shadow the 'clone' command I suggest adding a variant command $ git config --global alias.cloner = 'clone --recursive'

[ELLIOTTCABLE]

Both of you need to remove the = mark: git config --global alias.clone 'clone --recursive'

[Jez]

NOTE: this answer is completely wrong. git will not let you "shadow alias" an existing git command. The alias.clone will be completely ignored.

[Andrew T.]

Supporting Jez's comment: Is it possible to override git command by git alias?