Skip to content

Latest commit

 

History

History
104 lines (78 loc) · 4.94 KB

README.md

File metadata and controls

104 lines (78 loc) · 4.94 KB
Raw

mud

Version AUR Version Test projects integrity Publish Python Package Publish to AUR

Demo

mud is a multi-directory git runner which allows you to run git commands in a multiple repositories. It has multiple powerful tools filtering tools and support of aliasing. This tool is not limited to git commands only, you can run any commands as you wish, but this tool was primarily designed to be used with git, so each referenced directory should have .git.

Installing

For PyPI

pip install mud-git

For Arch Linux

paru -S mud-git

Getting started

  1. Run mud config to start interactive wizard which help you to set the preferable settings. Check settings section for more. At the end, .mudsettings file will appear at your home directory that you can alter in the future.
  2. Locate to your preferable directory with repositories.
  3. Run mud init command to create .mudconfig file. This file is important to keep references to repositories. All repositories in current dictionary would be included to .mudconfig.
  4. Optional: Run mud set-global to make current configuration default and reachable from any directory.

All entries are stored in .mudconfig in TSV format. After making your first entry, you can open .mudconfig in a text editor and modify it according to your needs.

Using

Commands

  • mud set-global - sets current .mudconfig as a global configuration, so it would be used as a fallback configuration to run from any directory.
  • mud get-config - prints closest .mudconfig location.

mud <FILTER> <COMMAND> will execute bash command across all repositories. To filter repositories check arguments section.

  • mud info/mud i - displays branch divergence and working directory changes.
  • mud status/mud st - displays working directory changes.
  • mud log/mud l - displays latest commit message, it's time and it's author.
  • mud labels/mud lb - displays mud labels across repositories.
  • mud branch/mud br - displays all branches in repositories.
  • mud remote-branch/mud rbr - displays all branches in repositories.
  • mud tags/mud t - displays git tags in repositories.

Arguments

  • -l=<label> or --label=<label> - includes repositories with provided label.
  • -nl=<label> or --not-label=<label> - excludes repositories with provided label.
  • -b=<branch> or --branch=<branch> - includes repositories with provided branch.
  • -nb=<branch> or --not-branch=<branch> - excludes repositories with provided label.
  • -c or --command - explicit command argument. Use this whenever you're trying to run a complex command.
  • -m or --modified - filters out modified repositories.
  • -d or --diverged - filters repositories with diverged branches.
  • -t or --table - toggles default table view setting for run.
  • -a or --async - toggles asynchronous run feature.

Example:

# Filters out all repos with master branch and diverged branches and then runs pull command.
mud -b=master -d git pull

# Fetches all repositories that are not on master branch and have "personal" label but excluding ones with "work" label
mud -nb=master -l=personal -nl=work git fetch

Settings

Settings are stored in your home directory in .mudsettings file.

  • run_async = 0/1 - enables asynchronous commands.
  • run_table = 0/1 - enables asynchronous commands in a table view. Requires run_async.
  • nerd_fonts = 0/1 - use nerd fonts in output 💅.
  • show_borders = 0/1 - enables borders in table view.
  • collapse_paths = 0/1 - simplifies branch name in branch view.
  • config_path = /home/user/path/.mudconfig - this is set up by mud --set-global command.

Aliases

You can create your own aliases. To create, edit .mudsettings file's, [alias] section. .mudsettings has the following aliases by default:

[alias]
to = git checkout
fetch = git fetch
pull = git pull
push = git push

Labeling

You can modify your .mudconfig file by using following commands:

Adding and labeling repositories

  • mud add <label> <path> - adds path with an optional label.
  • mud add <path> - adds path without a label.

Removing labels and repositories

  • mud remove <label> - removes label from all directories.
  • mud remove <path> - removes directory with a specified path.
  • mud remove <label> <path> - removes label from a directory.