Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mattzcarey authored Jul 12, 2023
1 parent e8f8fef commit 1d00d32
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code Review GPT

The Code Review GPT is a command-line application that uses AI to suggest changes on code in files that are being staged for commit. It helps streamline the code review process by providing feedback on code that may have issues or areas for improvement.
The Code Review GPT uses AI to suggest changes to code in files that are being staged for commit. It helps streamline the code review process by providing feedback on code that may have issues or areas for improvement. It can also be ran in your CI/CD pipeline to help speed up code reviews.

It should pick up on common issues such as:

Expand All @@ -9,19 +9,17 @@ It should pick up on common issues such as:
- Slow or inefficient code
- Unreadable code

Please note that this is in alpha and should be used for fun only. It may provide useful suggestions or they may be completely wrong. Please do not use this in a production environment.
Just so you know, this is in alpha and should be used for fun only. It may provide helpful suggestions or they may be completely wrong.

## Demo

https://github.com/mattzcarey/code-review-gpt/assets/77928207/92029baf-f691-465f-8d15-e1363fcb808e

## Prerequisites

- Node.js
- Git

## One-line Usage

```shell
npx code-review-gpt
```

## CI Usage (GitHub Actions)

```yml
Expand Down Expand Up @@ -77,7 +75,7 @@ When used globally you should run `export OPENAI_API_KEY=YOUR_API_KEY` (or simil

### Not installed globally

Run `npx code-review-gpt` in the root directory of a git repository.
Run `npm i code-review-gpt && npx code-review-gpt` in the root directory of a git repository.

### Installed globally

Expand All @@ -86,7 +84,17 @@ Run `code-review-gpt` in the root directory of a git repository.
## Roadmap

- [ ] Make a more clever way to find the exact code to review
- [ ] Use some embeddings and vector store to build a knowledge graph
- [ ] Prompt engineering to refine the prompt
- [ ] Support different LLMs
- [ ] Use some embeddings and vector store to build a knowledge graph
- [ ] Cash in on the cloud offering

## Sponsors ❤️

<a href="https://www.quivr.app/">
<img src="https://github.com/mattzcarey/code-review-gpt/assets/77928207/30361248-3159-4535-8efb-b114989ae886" alt="quivr logo" width="150" height="150">
</a>

<a href="https://www.aleios.com/">
<img src="https://github.com/mattzcarey/code-review-gpt/assets/77928207/a47c2460-b866-433f-a4c9-efb5737d4fed" alt="aleios logo" width="150" height="150">
</a>

0 comments on commit 1d00d32

Please sign in to comment.