Skip to content

Commit c5ee5cd

Browse files
committed
Merge remote-tracking branch 'origin/dev'
2 parents 7ddbaf4 + 3125404 commit c5ee5cd

18 files changed

+14293
-4060
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,14 @@ This is due to limit the number of tokens sent in each request. However, if you
8484
oco --fgm
8585
```
8686

87+
#### Skip Commit Confirmation
88+
89+
This flag allows users to automatically commit the changes without having to manually confirm the commit message. This is useful for users who want to streamline the commit process and avoid additional steps. To use this flag, you can run the following command:
90+
91+
```
92+
oco --yes
93+
```
94+
8795
## Configuration
8896

8997
### Local per repo configuration
@@ -97,7 +105,7 @@ OCO_TOKENS_MAX_OUTPUT=<max response tokens (default: 500)>
97105
OCO_OPENAI_BASE_PATH=<may be used to set proxy path to OpenAI api>
98106
OCO_DESCRIPTION=<postface a message with ~3 sentences description of the changes>
99107
OCO_EMOJI=<boolean, add GitMoji>
100-
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'>
108+
OCO_MODEL=<either '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'>
101109
OCO_LANGUAGE=<locale, scroll to the bottom to see options>
102110
OCO_MESSAGE_TEMPLATE_PLACEHOLDER=<message template placeholder, default: '$msg'>
103111
OCO_PROMPT_MODULE=<either conventional-commit or @commitlint, default: conventional-commit>
@@ -150,6 +158,20 @@ oco config set OCO_MODEL=gpt-4-0125-preview
150158

151159
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.
152160

161+
### Switch to Azure OpenAI
162+
163+
By default OpenCommit uses [OpenAI](https://openai.com).
164+
165+
You could switch to [Azure OpenAI Service](https://learn.microsoft.com/azure/cognitive-services/openai/)🚀
166+
167+
```sh
168+
opencommit config set OCO_AI_PROVIDER=azure
169+
```
170+
171+
Of course need to set 'OPENAI_API_KEY'. And also need to set the
172+
'OPENAI_BASE_PATH' for the endpoint and set the deployment name to
173+
'model'.
174+
153175
### Locale configuration
154176

155177
To globally specify the language used to generate commit messages:

0 commit comments

Comments
 (0)