Submarine attempts to make managing a project's dependencies with git submodules less cumbersome, more developer-friendly and more familiar, by corraling its commands into a familiar package manager workflow.

Install Submarine on your system and then use it in any git directory to manage your submodules, just like you would with composer, npm, etc.

However, where git submodules will, by default, fetch one level of submodule dependencies, Submarine will fetch all dependencies recursively. However, instead of installing in recursive nested subdirectories, Submarine will add these dependency repos in a flattened structure within the configured submodules directory, thus avoiding the occurrence of multiple duplicated nested submodules.

An installed submodule remains a git repo, however the core concept here is make changes to a dependency upstream and to strictly treat a dependency as a third-party.

TODO

After requiring a repo in your project, Submarine will create an autoload bash script within the configured submodules directory. Using bash to source this file will declare a variable (within the scope of the calling process) as a normalized version of the name of the required submodule. This variable's value is an absolute path to the submodule's main directory which allows a project to refer to a dependency dynamically.