50 lines
981 B
Markdown
50 lines
981 B
Markdown
# git-diff-explainer-cli
|
|
|
|
A CLI tool that uses LLMs to explain git diffs in natural language.
|
|
|
|
## Features
|
|
|
|
- Explain git diffs using AI (OpenAI, Anthropic, or local LLMs)
|
|
- Support for multiple diff formats (unified, side-by-side, stats)
|
|
- Configurable explanation depth (brief, detailed, comprehensive)
|
|
- Interactive mode for follow-up questions
|
|
- Batch processing of multiple files
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pip install git-diff-explainer-cli
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Basic Usage
|
|
|
|
```bash
|
|
gdiffer explain
|
|
```
|
|
|
|
### Options
|
|
|
|
```bash
|
|
--format TEXT Output format (text, json, markdown) [default: text]
|
|
--depth TEXT Explanation depth (brief, detailed, comprehensive) [default: detailed]
|
|
--model TEXT LLM model to use (gpt-4, claude-3-opus, etc.)
|
|
--interactive Enable interactive mode
|
|
--batch Batch process multiple files
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Set your API key:
|
|
|
|
```bash
|
|
export OPENAI_API_KEY="your-key"
|
|
# or
|
|
export ANTHROPIC_API_KEY="your-key"
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|