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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file checol-0.2.2.tar.gz.

File metadata

  • Download URL: checol-0.2.2.tar.gz
  • Upload date:
  • Size: 626.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for checol-0.2.2.tar.gz
Algorithm Hash digest
SHA256 aad7b7899f602d42552b5e18f9b84aab793c6945897694b197c7391e73f6cf76
MD5 cf0cbab3b3ef3ea9a371e703d593ba08
BLAKE2b-256 b223f7823b99429495b2006c7408d78c3f1e092994fda52014871495e86e1869

See more details on using hashes here.

File details

Details for the file checol-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: checol-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for checol-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 27dbb8104e7af100ebfddd650b8221514647b8336e747619f9f56de9d1300270
MD5 54905e39e1f47b3b81e3b0b32fa991d4
BLAKE2b-256 4fdc7534886019dfcbee6c9f6264b2854314e8d87bbebb480b5ed69da07215bd

See more details on using hashes here.

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