Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jasursadikov/mud

🗃️ Multi repository git utility. Manage multiple git-repositories simultaneously.
https://github.com/jasursadikov/mud

cli git git-cli git-scm multi-git multi-repo

Last synced: about 2 months ago
JSON representation

🗃️ Multi repository git utility. Manage multiple git-repositories simultaneously.

Host: GitHub
URL: https://github.com/jasursadikov/mud
Owner: jasursadikov
License: mit
Created: 2023-12-28T13:09:31.000Z (about 1 year ago)
Default Branch: master
Last Pushed: 2024-10-23T14:54:20.000Z (2 months ago)
Last Synced: 2024-10-24T20:53:20.063Z (2 months ago)
Topics: cli, git, git-cli, git-scm, multi-git, multi-repo
Language: Python
Homepage:
Size: 1.08 MB
Stars: 16
Watchers: 3
Forks: 1
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# mud

![Version](https://img.shields.io/pypi/v/mud-git?logo=python)
![AUR Version](https://img.shields.io/aur/version/mud-git?logo=archlinux)
[![Test projects integrity](https://github.com/jasursadikov/mud/actions/workflows/test.yaml/badge.svg)](https://github.com/jasursadikov/mud/actions/workflows/test.yaml)
[![Publish Python Package](https://github.com/jasursadikov/mud/actions/workflows/publish-pypi.yaml/badge.svg)](https://github.com/jasursadikov/mud/actions/workflows/publish-pypi.yaml)
[![Publish to AUR](https://github.com/jasursadikov/mud/actions/workflows/publish-aur.yaml/badge.svg)](https://github.com/jasursadikov/mud/actions/workflows/publish-aur.yaml)

![Demo](./img.png)

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
```bash
pip install mud-git
```
For Arch Linux
```bash
paru -S mud-git
```

## Getting started

1. Run `mud config` to start interactive wizard which help you to set the preferable settings. Check [settings](#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`](#commands) 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 ` will execute bash command across all repositories. To filter repositories check [arguments](#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=` or `--label=` - includes repositories with provided label.
- `-nl=` or `--not-label=` - excludes repositories with provided label.
- `-b=` or `--branch=` - includes repositories with provided branch.
- `-nb=` or `--not-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:

```bash
# 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](#global-mudconfig).

### 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 ` - adds path with an optional label.
- `mud add ` - adds path without a label.

### Removing labels and repositories

- `mud remove ` - removes label from all directories.
- `mud remove ` - removes directory with a specified path.
- `mud remove ` - removes label from a directory.