gitassist 0.2.5

AI-powered Git helper

GitAssist

GitAssist is a command-line tool that uses OpenAI to generate commit messages and pull request descriptions based on your Git history and staged changes. It streamlines your Git workflow by suggesting clear, concise, and contextually appropriate messages.

Features

• Automatically generate commit messages from staged changes
• Automatically generate PR titles and descriptions from commit history
• Push the current branch and open the PR creation page on GitHub or GitLab

Installation

Using pipx (Recommended)

pipx allows you to install and run Python applications in isolated environments, ensuring that your system Python packages remain untouched.

• On macOS (using Homebrew):

  brew install pipx
  pipx ensurepath
  

  After running pipx ensurepath, restart your terminal to apply the changes.

• On Linux (Debian/Ubuntu):

  sudo apt update
  sudo apt install pipx
  pipx ensurepath
  

  After running pipx ensurepath, restart your terminal to apply the changes.

• On Windows:

  python -m pip install --user pipx
  python -m pipx ensurepath
  

  After running pipx ensurepath, restart your terminal to apply the changes.

For more detailed instructions, refer to the official pipx installation guide: pipx.pypa.io

• Install Command

  pipx install gitassist
  

Usage

Initialize the tool with your OpenAI API key:

GitAssist init

GitAssist README

Generate and commit with an AI-suggested message:

GitAssist commit

Generate a PR title and description, push your branch, and open the PR page:

GitAssist new-pr --base main

Requirements

• Python 3.7+
• git must be installed and available on your system path
• A valid OpenAI API key

Assumptions

GitAssist assumes a few things about your development workflow:

1. Branching Model: You are working on a feature branch that diverged from a long-lived base branch like main.
2. Staging Area: When running GitAssist commit, you have already staged your changes.
3. Remote Setup: You have a remote named origin pointing to a GitHub or GitLab repository. GitAssist README
4. Authentication: You are authenticated with the remote (e.g., via SSH or HTTPS credentials) and have permission to push.
5. Push Before PR: Your local branch does not need to be pushed manually before PR creation — GitAssist pushes it for you.
6. Platform Detection: GitAssist can detect whether you're using GitHub or GitLab based on your origin URL.

License

MIT License