Skip to content

Commit 6f1e4bc

Browse files
committed
Merge remote-tracking branch 'origin/master' into dev
2 parents 8361dc6 + 2059549 commit 6f1e4bc

File tree

7 files changed

+414
-203
lines changed

7 files changed

+414
-203
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ git add <files...>
5858
oco
5959
```
6060

61-
Link to the GitMoji specification: https://gitmoji.dev/
61+
### Running locally with Ollama
6262

6363
You can also run it with local model through ollama:
6464

@@ -70,18 +70,30 @@ You can also run it with local model through ollama:
7070
git add <files...>
7171
OCO_AI_PROVIDER='ollama' opencommit
7272
```
73+
7374
If you want to use a model other than mistral, you can do so by setting the `OCO_AI_PROVIDER` environment variable as follows:
7475

7576
```sh
7677
OCO_AI_PROVIDER='ollama/llama3:8b' opencommit
7778
```
7879

80+
if you have ollama that is set up in docker/ on another machine with GPUs (not locally), you can change the default endpoint url.
81+
You can do so by setting the `OCO_OLLAMA_API_URL` environment variable as follows:
82+
83+
```sh
84+
OCO_OLLAMA_API_URL='http://192.168.1.10:11434/api/chat' opencommit
85+
```
86+
87+
where 192.168.1.10 is example of endpoint URL, where you have ollama set up.
88+
7989
### Flags
8090

8191
There are multiple optional flags that can be used with the `oco` command:
8292

8393
#### Use Full GitMoji Specification
8494

95+
Link to the GitMoji specification: https://gitmoji.dev/
96+
8597
This flag can only be used if the `OCO_EMOJI` configuration item is set to `true`. This flag allows users to use all emojis in the GitMoji specification, By default, the GitMoji full specification is set to `false`, which only includes 10 emojis (🐛✨📝🚀✅♻️⬆️🔧🌐💡).
8698
This is due to limit the number of tokens sent in each request. However, if you would like to use the full GitMoji specification, you can use the `--fgm` flag.
8799

@@ -125,7 +137,7 @@ Local config still has more priority than Global config, but you may set `OCO_MO
125137
Simply set any of the variables above like this:
126138

127139
```sh
128-
oco config set OCO_MODEL=gpt-4
140+
oco config set OCO_MODEL=gpt-4o
129141
```
130142

131143
Configure [GitMoji](https://gitmoji.dev/) to preface a message.
@@ -142,7 +154,7 @@ oco config set OCO_EMOJI=false
142154

143155
### Switch to GPT-4 or other models
144156

145-
By default, OpenCommit uses `gpt-3.5-turbo` model.
157+
By default, OpenCommit uses `gpt-4o` model.
146158

147159
You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
148160

@@ -153,17 +165,9 @@ oco config set OCO_MODEL=gpt-4
153165
or for as a cheaper option:
154166

155167
```sh
156-
oco config set OCO_MODEL=gpt-3.5-turbo
168+
oco config set OCO_MODEL=gpt-4o-mini
157169
```
158170

159-
or for GPT-4 Turbo (Preview) which is more capable, has knowledge of world events up to April 2023, a 128k context window and 2-3x cheaper vs GPT-4:
160-
161-
```sh
162-
oco config set OCO_MODEL=gpt-4-0125-preview
163-
```
164-
165-
Make sure that you spell it `gpt-4` (lowercase) and that you have API access to the 4th model. Even if you have ChatGPT+, that doesn't necessarily mean that you have API access to GPT-4.
166-
167171
### Switch to Azure OpenAI
168172

169173
By default OpenCommit uses [OpenAI](https://openai.com).
@@ -387,7 +391,7 @@ jobs:
387391
OCO_OPENAI_BASE_PATH: ''
388392
OCO_DESCRIPTION: false
389393
OCO_EMOJI: false
390-
OCO_MODEL: gpt-3.5-turbo
394+
OCO_MODEL: gpt-4o
391395
OCO_LANGUAGE: en
392396
OCO_PROMPT_MODULE: conventional-commit
393397
```

0 commit comments

Comments
 (0)