semvec/pypi-packages huggingface dataset:
gitbuddy 0.1.1
Git helper to commit and push easier and ChatGPT commit messages.
License: MIT
Requires Python: >=3.8

# GitBuddy

**GitBuddy** is a cli tool for committing and pushing changes in a git repo. It runs in your current working repo or [defaults](#default-repositories).

> [!WARNING]
> GitBuddy generates commit messages using [mods](https://github.com/charmbracelet/mods). You ***must*** have [mods](https://github.com/charmbracelet/mods) installed and setup for GitBuddy to work.

## Installation

```bash
git clone https://github.com/clamsfeel2/GitBuddy.git
cd GitBuddy
```

With [pipx](https://pipx.pypa.io/):

```bash
pipx install .
```

With [Poetry](https://python-poetry.org/):

```bash
poetry install
poetry run gb # Run from poetry shell
ln -s "$(poetry env info --path)/bin/gb" /somewhere/in/your/path/gb # Symlink to somewhere in your path instead
```

## Uninstallation

With pipx:

```bash
pipx uninstall gitbuddy
```

With Poetry:

```bash
poetry env list --full-path | grep gitbuddy | awk -F'/' '{print $NF}' | sed 's/ (Activated)//' | xargs poetry env remove
# Or remove the symlink you created
```

## Usage

```bash
gitbuddy [OPTIONS]
```

### Options

| Option            | Description                                 |
| ----------------- | ------------------------------------------- |
| `-c`, `--commit`  | Commit changes only                         |
| `-p`, `--push`    | Push changes only                           |
| `-a`, `--all`     | Apply action(s) to all default repositories |
| `-v`, `--version` | Show version and exit                       |
| `-h`, `--help`    | Show help message and exit                  |

## Default Repositories

When using `--all`, **GitBuddy** operates on these default paths:

- `/Users/Eli/Repos/Ah`
- `/Users/Eli/Repos/Eh`
- `/Users/Eli/Documents/Mollusk/Documents/Notes`

## License

[TBD LICENSE](LICENSE)