Skip to main content

An AI assistant for git operations using FastMCP.

Project description

Git MCP Assistant

Git Flash Logo

This tool uses FastMCP and the Google Gemini API to provide an AI-powered git assistant. It can function as an agent to execute a series of git commands based on natural language, or it can be used to simply generate a commit message for your staged changes.

Setup

  1. Set Your API Key: This tool requires a Gemini API key. The first time you run it, it will prompt you to enter your key and offer to save it to ~/.config/git-flash/.env. Alternatively, you can set it as an environment variable:

    export GEMINI_API_KEY="your-gemini-api-key"
    
  2. Install the Package: Navigate to the git-flash directory and install it using pip. Using the -e flag (editable mode) is recommended for development.

    pip install -e .
    

    This command installs the git-flash command into your system's PATH.

Usage

You can run the assistant from within any git repository directory.

Mode 1: Agentic Flow (Natural Language)

Provide an instruction in plain English, and the agent will determine the necessary git commands and execute them one by one.

Examples:

# Create a new branch and switch to it
git flash "create a new feature branch called 'login-flow' and check it out"

# Stash changes, switch branches, and pop the stash
git flash "stash my current work, switch to the 'main' branch, and then apply my stash"

# List all branches, local and remote
git flash "show me all the branches"

Mode 2: Manual Commit Message

If you know what you want to commit, use the -m or --message option. This will stage all current changes and commit with your message.

git flash -m "feat: add user authentication endpoint"

Dry Run

For any of the modes, you can add the --dry-run flag to see what commands the agent would run without actually executing them. This is great for safety and testing.

git flash "create a hotfix branch and merge it into main" --dry-run

Project details


Download files

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

Source Distribution

git_flash-0.1.7.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

git_flash-0.1.7-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file git_flash-0.1.7.tar.gz.

File metadata

  • Download URL: git_flash-0.1.7.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for git_flash-0.1.7.tar.gz
Algorithm Hash digest
SHA256 ad613fc914653a7dc0bd67206612dd8899db9078d1e8dd2026e7a29bac23a514
MD5 1ad4797299a3ff4f1162424e19286548
BLAKE2b-256 b69f0b689e61c5cbfdc9540562a0431d67a50705c51ca509ae3e8804123bdc8a

See more details on using hashes here.

File details

Details for the file git_flash-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: git_flash-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for git_flash-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f72f10453324493288b64e083aad89848665c40a8d0580968fa09e0f6d3ecbb2
MD5 23e8b2bd0c66461c70e3b68463b45096
BLAKE2b-256 5d5e713fd027f353ca641cf95d72ed4aab32a41e436f7acb2a71d5bfed737f9e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page