https://github.com/pierregode/gptcode-reviewer
AI GPTcode-reviwer
https://github.com/pierregode/gptcode-reviewer
Last synced: 4 months ago
JSON representation
AI GPTcode-reviwer
- Host: GitHub
- URL: https://github.com/pierregode/gptcode-reviewer
- Owner: PierreGode
- License: mit
- Created: 2024-09-03T11:11:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-11T06:18:37.000Z (11 months ago)
- Last Synced: 2026-01-14T20:34:15.363Z (5 months ago)
- Language: TypeScript
- Size: 860 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Open AI GPTcode-reviewer
[](https://snyk.io/test/github/PierreGode/GPTcode-reviwer) [](https://github.com/PierreGode/GPTcode-reviwer/issues) [](https://github.com/PierreGode/GPTcode-reviwer/pulls)   [](https://github.com/PierreGode/GPTcode-reviwer/blob/main/LICENSE)
[](https://ko-fi.com/J3J2EARPK)
Open AI GPTcode-reviewer is a GitHub Action that leverages OpenAI's GPT-4o-mini API to provide intelligent feedback and suggestions on
your pull requests. This powerful tool helps improve code quality and saves developers time by automating the code
review process.
## Features
- Reviews pull requests using OpenAI's GPT-4o API.
- Provides intelligent comments and suggestions for improving your code.
- Filters out files that match specified exclude patterns.
- Easy to set up and integrate into your GitHub workflow.
## GPT-4o mini
- GPT-4o mini is our most cost-efficient small model that’s smarter and cheaper than GPT-3.5 Turbo, and has vision capabilities. The model has 128K context and an October 2023 knowledge cutoff.
- gpt-4o-mini
- $0.150 / 1M input tokens
- $0.600 / 1M output tokens
## Setup
1. To use this GitHub Action, you need an OpenAI API key. If you don't have one, sign up for an API key
at [OpenAI](https://beta.openai.com/signup).
2. Add the OpenAI API key as a GitHub Secret in your repository with the name `OPENAI_API_KEY`. You can find more
information about GitHub Secrets [here](https://docs.github.com/en/actions/reference/encrypted-secrets).
3. Create a `.github/workflows/main.yml` file in your repository and add the following content:
#### See INSTALL.md
4. Replace `your-username` with your GitHub username or organization name where the AI Code Reviewer repository is
located.
5. Customize the `exclude` input if you want to ignore certain file patterns from being reviewed.
6. Commit the changes to your repository, and AI Code Reviewer will start working on your future pull requests.
## How It Works
The GPTcode-reviewer GitHub Action retrieves the pull request diff, filters out excluded files, and sends code chunks to
the OpenAI API. It then generates review comments based on the AI's response and adds them to the pull request.
## Add your badge to readme
```
```
## Contributing
Contributions are welcome! Please feel free to submit issues or pull requests to improve the GPTcode-reviewer GitHub
Action.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.