Skip to main content

Scan local or remote git repositories for history divergent from origin

Project description

Git-Scan

Git-Scan is a command-line utility to scan local or remote git repositories for history that is divergent from the remote branch. It is particularly useful when dealing with multiple git repositories across multiple machines where pulls and pushes are missed, stashes are forgotten about, files are left untracked, etc.

Features

  • Scan repositories for missing push & pulls, uncommited changes, untracked files, leftover stashes, and dangling branches
  • Automatically pull or push a group of repositories
  • Open repositories in need of changes in TMUX windows
  • Execute over SSH to git-scan on a different computer
  • Configuration file to list scannable repositories

Usage

To run a git-scan

git-scan [--push] [--pull] [--repo] [--tmux] [--ssh]

where the optional arguments are

  • push: push repository changes if ahead of remote
  • pull: pull repository changes if behind remote and there are no merge conflicts
  • repo: list of repositories to scan (defaults to all in the configuration file)
  • tmux: open all repositories with problems to fix in a TMUX window
  • ssh: run the git-scan on the provided ssh host

To add a repository to the list of scannable repositories

git-scan add /path/to/repository

To remove a repository

git-scan remove /path/to/repository

To list all scannable repositories

git-scan list [--resolve]

Installation

Git-Scan can be installed with pip

pip install git-scan

If installed with the --user flag, make sure to add ~/.local/bin to your PATH

Configuration File

A configuration file located at ~/.config/git-scan/git-scan.conf is created. This is a TOML file listing the scannable repositories:

repositories = ["/path/to/repository_1", "/path/to/repository_2"]

The config file can be editted manually or changed using the add and remove commands. Glob patterns and tilde expansions are allowed, i.e. "~/path/to/repos/*"

License

Git-Scan is licensed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for git-scan, version 0.2.1
Filename, size & hash File type Python version Upload date
git_scan-0.2.1-py3-none-any.whl (7.1 kB) View hashes Wheel py3
git-scan-0.2.1.tar.gz (6.4 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page