https://github.com/gifflet/git-review
Git Review is a command-line tool that simplifies code reviews by allowing developers to quickly compare Git commits, analyze changes, and save diffs, streamlining the review process.
https://github.com/gifflet/git-review
cli-tool code-review dev-tools git go
Last synced: about 1 year ago
JSON representation
Git Review is a command-line tool that simplifies code reviews by allowing developers to quickly compare Git commits, analyze changes, and save diffs, streamlining the review process.
- 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-03-24T21:23:34.000Z (about 1 year ago)
- Last Synced: 2025-03-24T22:26:53.417Z (about 1 year ago)
- Topics: cli-tool, code-review, dev-tools, git, go
- Language: Go
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
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
## Quick Start 🚀
```bash
# Clone the repository
git clone https://github.com/gifflet/git-review.git
# Build the binary
cd git-review
go build .
# Basic usage
git-review [final_commit]
```
## 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
## Installation 🛠️
### Method 1: Build from Source
```bash
git clone https://github.com/gifflet/git-review.git
cd git-review
go build .
```
### Method 2: Go Install (Coming Soon)
```bash
go install github.com/gifflet/git-review@latest
```
## Usage 📖
### Basic Command Structure
```bash
git-review [final_commit] [options]
```
### Comprehensive Options
- ``: **Required**. Starting commit hash for comparison
- `[final_commit]`: **Optional**. Ending commit hash (defaults to `HEAD`)
- `--main-branch `: Optional main branch for refined comparisons
- `--project-path `: Optional project directory path
- `--output-dir `: Optional output directory for diff files
### Detailed Usage Scenarios
#### 1. Basic Commit Comparison
```powershell
git-review c9286370 78094299
```
#### 2. Comparing with Main Branch Context
```powershell
git-review c9286370 78094299 --main-branch main
```
#### 3. Specifying Custom Project and Output Paths
```powershell
git-review c9286370 78094299 \
--main-branch main \
--project-path "C:\Projects\MyRepo" \
--output-dir "./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! 🎉**