Adding a submodule

You can include another Git repository as a folder within your project, tracked by Git:

$ git submodule add https://github.com/jquery/jquery.git

You should add and commit the new .gitmodules file; this tells Git what submodules should be cloned when git submodule update is run.

Found a mistake? Have a question or improvement idea? Let me know.

Submodules/

Clone a git repository having submodules

Updating a submodule

Adding a submodule

Setting a submodule to follow a branch

Moving a submodule

Removing a submodule

Table Of Contents

1 Getting started

2 Committing

3 Browsing the history

4 Undoing

5 Staging

6 Git diff

7 Merging

8 Ignoring files and folders

9 Working with remotes

10 Submodules

11 Aliases

12 Rebasing

13 Configuration

14 Branching

15 rev-list

16 Squashing

17 Cherry picking

18 Recovering

19 git clean

20 .gitattributes

21 .mailmap

22 Different workflows

23 Pulling

24 Hooks

25 Cloning repositories

26 Stashing

27 Subtrees

28 Renaming

29 Pushing

30 Internals

31 git-tfs

32 Empty directories in git

33 git-svn

34 Archive

35 Rewriting history with filter-branc

36 Migrating to git

37 Show

38 Resolving merge conflicts

39 Bundles

40 Display commit history graphically with gitk

41 Bisecting to find faulty commits

42 Blaming

43 Git revisions syntax

44 Worktrees

45 Git remote

46 Git large file storage

47 git patch

48 git statistics

49 git send-email

50 git gui clients

51 reflog - restoring commits not shown in git log

52 TortoiseGit

53 External merge and diff tools

54 Update object name in reference

55 Git branch name on Bash Ubuntu

56 Git client-side hooks

57 Git rerer

58 Change git repository name

59 git tagging

60 tidying up your local and remote repository

61 diff tree

62 Contributors