Overview

Gitman is a language-agnostic dependency manager using Git. It aims to serve as a submodules replacement and provides advanced options for managing versions of nested Git repositories.

Setup

Requirements

• Python 3.10+
• Git 2.8+ (with stored credentials)

Installation

Install this tool globally with pipx (or pip):

$ pipx install gitman

or add it to your Poetry project:

$ poetry add gitman

Configuration

Generate a sample config file:

$ gitman init

or manually create one (gitman.yml or .gitman.yml) in the root of your working tree:

location: vendor/gitmansources:
- repo: "https://github.com/kstenerud/iOS-Universal-Framework"name: frameworkrev: Mk5-end-of-life
- repo: "https://github.com/jonreid/XcodeCoverage"name: coveragelinks:
- target: Tools/XcodeCoverage
- repo: "https://github.com/dxa4481/truffleHog"name: trufflehogrev: masterscripts:
- chmod a+x truffleHog/truffleHog.py
- repo: "https://github.com/FortAwesome/Font-Awesome"name: fontawesomerev: mastersparse_paths:
- "webfonts/*"
- repo: "https://github.com/google/material-design-icons"name: material-design-iconsrev: mastergroups:
- name: codemembers:
- framework
- trufflehog
- name: resourcesmembers:
- fontawesome
- material-design-iconsdefault_group: code

Ignore the dependency storage location:

$ echo vendor/gitman >> .gitignore

Usage

See the available commands:

$ gitman --help

Updating Dependencies

Get the latest versions of all dependencies:

$ gitman update

which will essentially:

1. Create a working tree at <root>/<location>/<name>
2. Fetch from repo and checkout the specified rev
3. Symbolically link each <location>/<name> from <root>/<link> (if specified)
4. Repeat for all nested working trees containing a config file
5. Record the actual commit SHAs that were checked out (with --lock option)
6. Run optional post-install scripts for each dependency

where rev can be:

• all or part of a commit SHA: 123def
• a tag: v1.0
• a branch: main
• a rev-parse date: 'main@{2015-06-18 10:30:59}'

Alternatively, get the latest versions of specific dependencies:

$ gitman update framework

or named groups:

$ gitman update resources

Restoring Previous Versions

Display the versions that are currently installed:

$ gitman list

Reinstall these specific versions at a later time:

$ gitman install

Deleting Dependencies

Remove all installed dependencies:

$ gitman uninstall

Resources

• Source code
• Issue tracker
• Release history