|
8 | 8 |
|
9 | 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 |
| -* [繁體中文介紹][1] |
12 |
| -* [繁體中文影片][2] |
| 11 | +- [繁體中文介紹][1] |
| 12 | +- [繁體中文影片][2] |
13 | 13 |
|
14 |
| -[1]:https://blog.wu-boy.com/2023/03/writes-git-commit-messages-using-chatgpt/ |
15 |
| -[2]:https://www.youtube.com/watch?v=4Yei_t6eMZU |
| 14 | +[1]: https://blog.wu-boy.com/2023/03/writes-git-commit-messages-using-chatgpt/ |
| 15 | +[2]: https://www.youtube.com/watch?v=4Yei_t6eMZU |
16 | 16 |
|
17 | 17 | 
|
18 | 18 |
|
19 | 19 | ## Features
|
20 | 20 |
|
21 |
| -* Supports [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]. |
22 |
| -* Supports [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/). |
23 |
| -* 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. |
| 21 | +- Supports [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]. |
| 22 | +- Supports [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/). |
| 23 | +- 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 |
|
@@ -141,18 +141,10 @@ codegpt config set openai.api_key gsk_xxxxxxxxxxxxxx
|
141 | 141 | codegpt config set openai.model llama3-8b-8192
|
142 | 142 | ```
|
143 | 143 |
|
144 |
| -Support the [following models][32]: |
| 144 | +GroqCloud currently supports the [following models][32]: |
145 | 145 |
|
146 |
| -1. `llama-3.1-8b-instant` (Meta) |
147 |
| -2. `llama-3.1-70b-versatile` (Meta) |
148 |
| -3. `llama-3.1-405b-reasoning` (Meta) |
149 |
| -4. `llama3-8b-8192` (Meta) |
150 |
| -5. `llama3-70b-8192` (Meta) |
151 |
| -6. `llama3-groq-8b-8192-tool-use-preview` |
152 |
| -7. `llama3-groq-70b-8192-tool-use-preview` |
153 |
| -8. `mixtral-8x7b-32768` (Mistral) |
154 |
| -9. `gemma2-9b-it` (Google) |
155 |
| -10. `gemma-7b-it` (Google) |
| 146 | +1. [Production Models](https://console.groq.com/docs/models#production-models) |
| 147 | +2. [Preview Models](https://console.groq.com/docs/models#preview-models) |
156 | 148 |
|
157 | 149 | [30]: https://groq.com/
|
158 | 150 | [31]: https://console.groq.com/keys
|
@@ -206,19 +198,19 @@ codegpt config set openai.api_key sk-or-v1-xxxxxxxxxxxxxxxx
|
206 | 198 | codegpt config set openai.model google/learnlm-1.5-pro-experimental:free
|
207 | 199 | ```
|
208 | 200 |
|
209 |
| -[50]:https://openrouter.ai/ |
210 |
| -[51]:https://openrouter.ai/docs#models |
211 |
| -[52]:https://openrouter.ai/terms#services |
212 |
| -[53]:https://openrouter.ai/api/v1/models |
| 201 | +[50]: https://openrouter.ai/ |
| 202 | +[51]: https://openrouter.ai/docs#models |
| 203 | +[52]: https://openrouter.ai/terms#services |
| 204 | +[53]: https://openrouter.ai/api/v1/models |
213 | 205 |
|
214 | 206 | For including your app on openrouter.ai rankings and Shows in rankings on openrouter.ai, you can set the `openai.headers` in your config file.
|
215 | 207 |
|
216 | 208 | ```sh
|
217 | 209 | codegpt config set openai.headers "HTTP-Referer=https://github.com/appleboy/CodeGPT X-Title=CodeGPT"
|
218 | 210 | ```
|
219 | 211 |
|
220 |
| -* **HTTP-Refer**: Optional, for including your app on openrouter.ai rankings. |
221 |
| -* **X-Title**: Optional, for Shows in rankings on openrouter.ai. |
| 212 | +- **HTTP-Refer**: Optional, for including your app on openrouter.ai rankings. |
| 213 | +- **X-Title**: Optional, for Shows in rankings on openrouter.ai. |
222 | 214 |
|
223 | 215 | ## Usage
|
224 | 216 |
|
@@ -472,5 +464,5 @@ make test
|
472 | 464 |
|
473 | 465 | ## Reference
|
474 | 466 |
|
475 |
| -* [OpenAI Chat completions documentation](https://platform.openai.com/docs/guides/chat). |
476 |
| -* [Introducing ChatGPT and Whisper APIs](https://openai.com/blog/introducing-chatgpt-and-whisper-apis) |
| 467 | +- [OpenAI Chat completions documentation](https://platform.openai.com/docs/guides/chat). |
| 468 | +- [Introducing ChatGPT and Whisper APIs](https://openai.com/blog/introducing-chatgpt-and-whisper-apis) |
0 commit comments