opencommit 3.2.7 → 3.2.8
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 +14 -1
- package/out/cli.cjs +9908 -7629
- package/package.json +12 -7
package/README.md
CHANGED
|
@@ -109,11 +109,12 @@ Create a `.env` file and add OpenCommit config variables there like this:
|
|
|
109
109
|
OCO_AI_PROVIDER=<openai (default), anthropic, azure, ollama, gemini, flowise, deepseek>
|
|
110
110
|
OCO_API_KEY=<your OpenAI API token> // or other LLM provider API token
|
|
111
111
|
OCO_API_URL=<may be used to set proxy path to OpenAI api>
|
|
112
|
+
OCO_API_CUSTOM_HEADERS=<JSON string of custom HTTP headers to include in API requests>
|
|
112
113
|
OCO_TOKENS_MAX_INPUT=<max model token limit (default: 4096)>
|
|
113
114
|
OCO_TOKENS_MAX_OUTPUT=<max response tokens (default: 500)>
|
|
114
115
|
OCO_DESCRIPTION=<postface a message with ~3 sentences description of the changes>
|
|
115
116
|
OCO_EMOJI=<boolean, add GitMoji>
|
|
116
|
-
OCO_MODEL=<either 'gpt-4o', 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo'
|
|
117
|
+
OCO_MODEL=<either 'gpt-4o-mini' (default), 'gpt-4o', 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo', '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>
|
|
117
118
|
OCO_LANGUAGE=<locale, scroll to the bottom to see options>
|
|
118
119
|
OCO_MESSAGE_TEMPLATE_PLACEHOLDER=<message template placeholder, default: '$msg'>
|
|
119
120
|
OCO_PROMPT_MODULE=<either conventional-commit or @commitlint, default: conventional-commit>
|
|
@@ -132,6 +133,18 @@ Simply set any of the variables above like this:
|
|
|
132
133
|
oco config set OCO_MODEL=gpt-4o-mini
|
|
133
134
|
```
|
|
134
135
|
|
|
136
|
+
To see all available configuration parameters and their accepted values:
|
|
137
|
+
|
|
138
|
+
```sh
|
|
139
|
+
oco config describe
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
To see details for a specific parameter:
|
|
143
|
+
|
|
144
|
+
```sh
|
|
145
|
+
oco config describe OCO_MODEL
|
|
146
|
+
```
|
|
147
|
+
|
|
135
148
|
Configure [GitMoji](https://gitmoji.dev/) to preface a message.
|
|
136
149
|
|
|
137
150
|
```sh
|