You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Correct grammatical errors and improve clarity in the project description
- Change "Feature" section header to "Features"
- Correct grammatical errors and improve clarity in the "Features" list
- Correct "MacOS" to "macOS"
- Correct grammatical errors in instructions for storing API keys and obtaining API keys from Groq API Service
Signed-off-by: appleboy <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7

8
8
9
-
A CLI written in [Go](https://go.dev)language that writes git commit messages or do a code review brief for you using ChatGPT AI (gpt-3.5-turbo, gpt-4 model) and automatically installs a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks).
9
+
A CLI written in [Go](https://go.dev) that writes git commit messages or provides a code review summary for you using ChatGPT AI (gpt-3.5-turbo, gpt-4 model) and automatically installs a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks).
10
10
11
11
*[繁體中文介紹][1]
12
12
*[繁體中文影片][2]
@@ -16,23 +16,23 @@ A CLI written in [Go](https://go.dev) language that writes git commit messages o
16
16
17
17

18
18
19
-
## Feature
19
+
## Features
20
20
21
-
*Support[Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service), [OpenAI API](https://platform.openai.com/docs/api-reference), [Gemini][60], [Ollama][41], [Groq][30] and [OpenRouter][50].
*Supports Git prepare-commit-msg Hook, see the [Git Hooks documentation](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks).
24
+
*Supports customizing generated diffs with n lines of context, the default is three.
25
+
*Supports excluding files from the git diff command.
26
+
*Supports commit message translation into another language (supports`en`, `zh-tw`, or `zh-cn`).
27
+
*Supports socks proxy or custom network HTTP proxy.
28
+
*Supports[model lists](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38) like `gpt-4`, `gpt-3.5-turbo`, etc.
29
+
*Supports generating a brief code review.
30
30
31
31

32
32
33
33
## Installation
34
34
35
-
Install from [Homebrew](http://brew.sh/) on MacOS
35
+
Install from [Homebrew](http://brew.sh/) on macOS
36
36
37
37
```sh
38
38
brew tap appleboy/tap
@@ -45,7 +45,7 @@ Install from [Chocolatey](https://chocolatey.org/install) on Windows
45
45
choco install codegpt
46
46
```
47
47
48
-
The pre-compiled binaries can be downloaded from [release page](https://github.com/appleboy/CodeGPT/releases).Change the binary permissions to `755` and copy the binary to the system bin directory. Use the `codegpt` command as shown below.
48
+
The pre-compiled binaries can be downloaded from [release page](https://github.com/appleboy/CodeGPT/releases).Change the binary permissions to `755` and copy the binary to the system bin directory. Use the `codegpt` command as shown below.
49
49
50
50
```sh
51
51
$ codegpt version
@@ -64,15 +64,15 @@ Please first create your OpenAI API Key. The [OpenAI Platform](https://platform.
64
64
65
65

66
66
67
-
An environment variable is a variable that is set on your operating system, rather than within your application. It consists of a name and value.We recommend that you set the name of the variable to `OPENAI_API_KEY`.
67
+
An environment variable is a variable that is set on your operating system, rather than within your application. It consists of a name and value.We recommend that you set the name of the variable to `OPENAI_API_KEY`.
68
68
69
69
See the [Best Practices for API Key Safety](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety).
70
70
71
71
```sh
72
72
export OPENAI_API_KEY=sk-xxxxxxx
73
73
```
74
74
75
-
or store your API key in custom config file.
75
+
or store your API key in a custom config file.
76
76
77
77
```sh
78
78
codegpt config set openai.api_key sk-xxxxxxx
@@ -130,7 +130,7 @@ codegpt config set openai.model gemini-1.5-flash-latest
130
130
131
131
### How to change to [Groq][30] API Service
132
132
133
-
Please get the `API key` from Groq API Service, please vist[here][31]. Update the `base_url` and `api_key` in your config file.
133
+
Please get the `API key` from Groq API Service, please visit[here][31]. Update the `base_url` and `api_key` in your config file.
0 commit comments