Skip to content

Commit 69b3c00

Browse files
committed
docs(README): update OCO_AI_PROVIDER and OCO_MODEL instructions for clarity and add valid model name options to OCO_MODEL description
1 parent 6f4afbf commit 69b3c00

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ oco config set OCO_AI_PROVIDER='ollama'
7676
If you want to use a model other than mistral (default), you can do so by setting the `OCO_AI_PROVIDER` environment variable as follows:
7777

7878
```sh
79-
oco config set OCO_AI_PROVIDER='ollama/llama3:8b'
79+
oco config set OCO_AI_PROVIDER='ollama'
80+
oco config set OCO_MODEL='llama3:8b'
8081
```
8182

8283
If you have ollama that is set up in docker/ on another machine with GPUs (not locally), you can change the default endpoint url.
@@ -127,12 +128,12 @@ OCO_TOKENS_MAX_OUTPUT=<max response tokens (default: 500)>
127128
OCO_OPENAI_BASE_PATH=<may be used to set proxy path to OpenAI api>
128129
OCO_DESCRIPTION=<postface a message with ~3 sentences description of the changes>
129130
OCO_EMOJI=<boolean, add GitMoji>
130-
OCO_MODEL=<either 'gpt-4o', 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview' or any string basically, but it should be a valid model name>
131+
OCO_MODEL=<either 'gpt-4o', 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview' or any Anthropic or Ollama model or any string basically, but it should be a valid model name>
131132
OCO_LANGUAGE=<locale, scroll to the bottom to see options>
132133
OCO_MESSAGE_TEMPLATE_PLACEHOLDER=<message template placeholder, default: '$msg'>
133134
OCO_PROMPT_MODULE=<either conventional-commit or @commitlint, default: conventional-commit>
134135
OCO_ONE_LINE_COMMIT=<one line commit message, default: false>
135-
OCO_AI_PROVIDER=<openai (default), anthropic, azure, ollama or ollama/model>
136+
OCO_AI_PROVIDER=<openai (default), anthropic, azure, ollama>
136137
...
137138
```
138139

0 commit comments

Comments
 (0)