https://github.com/gifflet/git-review
🚀 Effortless Git code reviews – compare commits and analyze diffs.
https://github.com/gifflet/git-review
cli code-reviews dev-tool developer-tools git git-diff git-review golang
Last synced: 25 days ago
JSON representation
🚀 Effortless Git code reviews – compare commits and analyze diffs.
- Host: GitHub
- URL: https://github.com/gifflet/git-review
- Owner: gifflet
- License: mit
- Created: 2025-03-24T14:52:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-23T20:35:04.000Z (about 1 year ago)
- Last Synced: 2025-09-29T11:48:38.566Z (8 months ago)
- Topics: cli, code-reviews, dev-tool, developer-tools, git, git-diff, git-review, golang
- Language: Go
- Homepage:
- Size: 52.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Review 🚀
## Overview
Git Review is a powerful command-line tool designed to streamline code reviews by helping developers easily extract and analyze changes between Git commits.
## Prerequisites 🔍
- Git (version 2.25 or higher)
- Go (version 1.20 or higher)
- Operating Systems: Windows, macOS, Linux
## Installation 🛠️
To install Git Review, run:
```bash
go install github.com/gifflet/git-review@latest
```
The binary will be placed in:
- **Linux/macOS**: `$HOME/go/bin/git-review`
- **Windows**: `%USERPROFILE%\go\bin\git-review.exe`
### Configure Git Review as a Global Command
After installation, you must configure `git-review` as a global Git command for easier usage:
**Linux/macOS**:
```bash
git config --global alias.review '!"$HOME/go/bin/git-review"'
```
**Windows**:
```powershell
git config --global alias.review "!%USERPROFILE%/go/bin/git-review.exe"
```
Once configured, you can run `git review` from anywhere within your repositories.
## Quick Start 🚀
```bash
# Basic usage
git review -i
```
## Features ✨
- 📂 Compare two commits and get a comprehensive list of modified files
- 💾 Save diffs of modified files to a specified output directory
- 🌿 Flexible branch comparison with optional main branch filtering
## Usage 📚
### Basic Command Structure
```bash
git review -i [-f ] [options]
```
### Available Options
- `-i, --initial `: **Required**. Starting commit hash for comparison
- `-f, --final `: **Optional**. Ending commit hash (defaults to `HEAD`)
- `-m, --main-branch `: **Optional**. Main branch for refined comparisons
- `-p, --project-path `: **Optional**. Project directory path (defaults to current directory)
- `-o, --output-dir `: **Optional**. Output directory for diff files (defaults to `git-review`)
### Detailed Usage Scenarios
#### 1. Basic Commit Comparison
```powershell
git review -i c9286370
```
#### 2. Comparing Two Specific Commits
```powershell
git review -i c9286370 -f 78094299
```
#### 3. Comparing with Main Branch Context
```powershell
git review -i c9286370 -f 78094299 -m main
```
#### 4. Specifying Custom Project and Output Paths
```powershell
git review -i c9286370 -f 78094299 \
-m main \
-p "C:\Projects\MyRepo" \
-o "./review-output"
```
## Troubleshooting 🛠
### Common Issues
- **Permission Denied**: Ensure you have read/write permissions in the project directory
- **Commit Not Found**: Verify commit hashes are correct and exist in your repository
- **Large Repository**: For repositories with extensive history, the process might take longer
## Performance Considerations ⚡
- Recommended for repositories up to 10GB in size
- Processing time increases with number of files and commit complexity
- Large binary files might slow down diff generation
## Contributing 🤝
We welcome contributions! Please follow these steps:
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-improvement`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-improvement`)
5. Open a Pull Request
## License 📝
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
---
**Happy Reviewing! 🎉**