https://github.com/allyedge/gitsplain

A tool to summarise and explain your code changes, make it make sense!
https://github.com/allyedge/gitsplain

ai git git-tool git-tools openai python

Last synced: about 1 year ago
JSON representation

A tool to summarise and explain your code changes, make it make sense!

• Host: GitHub
• URL: https://github.com/allyedge/gitsplain
• Owner: Allyedge
• License: mit
• Created: 2025-03-28T20:31:06.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-29T21:01:37.000Z (about 1 year ago)
• Last Synced: 2025-03-29T21:25:38.756Z (about 1 year ago)
• Topics: ai, git, git-tool, git-tools, openai, python
• Language: Python
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Gitsplain

[![GitHub License](https://img.shields.io/github/license/Allyedge/gitsplain)](https://github.com/Allyedge/gitsplain)

[![GitHub Release](https://img.shields.io/github/v/release/Allyedge/gitsplain)](https://github.com/Allyedge/gitsplain)

A tool to summarise and explain your code changes, make it make sense!

## Environment Variables

```sh

OPENAI_API_KEY=YOUR_OPENAI_API_KEY

```

## Installation

```sh

# Install Gitsplain.

# Replace  and  with values from the desired release

VERSION="v0.1.0"; ASSET_NAME="gitsplain"; \

INSTALL_DIR="$HOME/.local/bin"; \

mkdir -p "$INSTALL_DIR"; \

echo "Downloading Gitsplain ${VERSION} (${ASSET_NAME})..."; \

curl -sL "https://github.com/Allyedge/gitsplain/releases/download/${VERSION}/${ASSET_NAME}" -o "${INSTALL_DIR}/gitsplain" && \

chmod +x "${INSTALL_DIR}/gitsplain" && \

echo "Installed Gitsplain to ${INSTALL_DIR}/gitsplain"; \

echo "Make sure ${INSTALL_DIR} is in your PATH, then run 'gitsplain --help' in a new terminal."

```

## Usage

```sh

# Run Gitsplain

> gitsplain

# Get help with Gitsplain

> gitsplain --help

```