Skip to main content

A CLI tool leveraging AI to analyze and explain Git diffs.

Project description

Checol

This tool is designed to analyze Git repository diffs and generate related text responses using the AI model. It enables you to get detailed explanations or clarifications on Git changes from AI.

Prerequisites

  • Python 3.8 or higher
  • Access to a Git local repository

Installation

pip install checol

Configuration

  1. Set your Anthropic API key in the environment variable ANTHROPIC_API_KEY.

    export ANTHROPIC_API_KEY='your_api_key_here'
    
  2. (Optional) If you want to change the default AI model, also set ANTHROPIC_API_MODEL.

    export ANTHROPIC_API_MODEL='claude-3-haiku-20240307'
    

Usage

  1. Use the diff command to analyze Git diffs and start interacting with Claude.

    checol diff [git diff options]
    
  2. Follow the prompts to input your description or questions regarding the Git diffs.

  3. Review the response from Claude and continue the interaction as desired.

License

This project is released under the MIT License

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

checol-0.2.2.tar.gz (626.1 kB view hashes)

Uploaded Source

Built Distribution

checol-0.2.2-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

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