deejgregor / submodule-graph

Visualize Git Submodule Graphs

Submodule Graph

Visualize Git Submodule Graphs

Install

$ pip install submodulegraph

Usage

$ submodulegraph --help

Usage: submodulegraph [OPTIONS] REPO

Options:
  -m, --mode TEXT       Output Mode: text | png  [default: text]
  -g, --graphmode TEXT  GraphMode: scattered | clustered  [default: scattered]
  -o, --out TEXT        Image filename  [default: graph]
  -u, --with-url        Add repo URLs  [default: False]
  -r, --relative-path   Show relative path  [default: False]
  --help                Show this message and exit.

Examples:
# (Default) print the structure of the submodules in text in the console.
$ submodulegraph <path to repo>

# Print the structure of the submodules in text in the console, including repo URLs.
$ submodulegraph -u <path to repo>

# Print the structure of the submodules in text in the console, including repo URLs and relative paths of submodule directories.
$ submodulegraph -u -r <path to repo>

# Create a png of the submodule structure where all the submodules are listed separately.
$ submodulegraph -m png <path to repo>

# Create a png of the submodule structure where all the submodules are only listed once.
$ submodulegraph -m png -g clustered <path to repo>