opencommit 3.0.15 → 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.
Files changed (3) hide show
  1. package/README.md +23 -1
  2. package/out/cli.cjs +6517 -1571
  3. package/package.json +2 -1
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
@@ -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:
@@ -174,7 +196,7 @@ All available languages are currently listed in the [i18n](https://github.com/di
174
196
  Pushing to git is on by default but if you would like to turn it off just use:
175
197
 
176
198
  ```sh
177
- oc config set OCO_GITPUSH=false
199
+ oco config set OCO_GITPUSH=false
178
200
  ```
179
201
 
180
202
  ### Switch to `@commitlint`