opencommit 3.0.12 → 3.0.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -1
- package/out/cli.cjs +25095 -7011
- package/out/tiktoken_bg.wasm +0 -0
- package/package.json +14 -2
package/README.md
CHANGED
|
@@ -84,6 +84,14 @@ This is due to limit the number of tokens sent in each request. However, if you
|
|
|
84
84
|
oco --fgm
|
|
85
85
|
```
|
|
86
86
|
|
|
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
|
+
|
|
87
95
|
## Configuration
|
|
88
96
|
|
|
89
97
|
### Local per repo configuration
|
|
@@ -97,7 +105,7 @@ OCO_TOKENS_MAX_OUTPUT=<max response tokens (default: 500)>
|
|
|
97
105
|
OCO_OPENAI_BASE_PATH=<may be used to set proxy path to OpenAI api>
|
|
98
106
|
OCO_DESCRIPTION=<postface a message with ~3 sentences description of the changes>
|
|
99
107
|
OCO_EMOJI=<boolean, add GitMoji>
|
|
100
|
-
OCO_MODEL=<either 'gpt-4', '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'>
|
|
101
109
|
OCO_LANGUAGE=<locale, scroll to the bottom to see options>
|
|
102
110
|
OCO_MESSAGE_TEMPLATE_PLACEHOLDER=<message template placeholder, default: '$msg'>
|
|
103
111
|
OCO_PROMPT_MODULE=<either conventional-commit or @commitlint, default: conventional-commit>
|
|
@@ -150,6 +158,20 @@ oco config set OCO_MODEL=gpt-4-0125-preview
|
|
|
150
158
|
|
|
151
159
|
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.
|
|
152
160
|
|
|
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
|
+
|
|
153
175
|
### Locale configuration
|
|
154
176
|
|
|
155
177
|
To globally specify the language used to generate commit messages:
|
|
@@ -169,6 +191,14 @@ oco config set OCO_LANGUAGE=française
|
|
|
169
191
|
The default language setting is **English**
|
|
170
192
|
All available languages are currently listed in the [i18n](https://github.com/di-sukharev/opencommit/tree/master/src/i18n) folder
|
|
171
193
|
|
|
194
|
+
### Push to git
|
|
195
|
+
|
|
196
|
+
Pushing to git is on by default but if you would like to turn it off just use:
|
|
197
|
+
|
|
198
|
+
```sh
|
|
199
|
+
oco config set OCO_GITPUSH=false
|
|
200
|
+
```
|
|
201
|
+
|
|
172
202
|
### Switch to `@commitlint`
|
|
173
203
|
|
|
174
204
|
OpenCommit allows you to choose the prompt module used to generate commit messages. By default, OpenCommit uses its conventional-commit message generator. However, you can switch to using the `@commitlint` prompt module if you prefer. This option lets you generate commit messages in respect with the local config.
|