You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,7 +76,7 @@ Interactive rebase (`rebase -i`) changes commit SHA, so commit history in remote
76
76
77
77
## Setup OpenCommit as a CLI
78
78
79
-
You can use OpenCommit by simply running it via CLI like this `oc`. 2 seconds and your staged changes are committed with a meaningful message.
79
+
You can use OpenCommit by simply running it via CLI like this `oco`. 2 seconds and your staged changes are committed with a meaningful message.
80
80
81
81
1. Install OpenCommit globally to use in any repository:
82
82
@@ -103,7 +103,7 @@ git add <files...>
103
103
opencommit
104
104
```
105
105
106
-
You can also use the `oc` shortcut:
106
+
You can also use the `oco` shortcut:
107
107
108
108
```sh
109
109
git add <files...>
@@ -133,19 +133,19 @@ Local config still has more priority as Global config, but you may set `OCO_MODE
133
133
Simply run any of the variable above like this:
134
134
135
135
```sh
136
-
oc config set OCO_OPENAI_API_KEY=gpt-4
136
+
oco config set OCO_OPENAI_API_KEY=gpt-4
137
137
```
138
138
139
139
Configure [GitMoji](https://gitmoji.dev/) to preface a message.
140
140
141
141
```sh
142
-
oc config set OCO_EMOJI=true
142
+
oco config set OCO_EMOJI=true
143
143
```
144
144
145
145
To remove preface emoji:
146
146
147
147
```sh
148
-
oc config set OCO_EMOJI=false
148
+
oco config set OCO_EMOJI=false
149
149
```
150
150
151
151
### Switch to GPT-4
@@ -155,7 +155,7 @@ By default OpenCommit uses GPT-3.5-turbo (ChatGPT).
155
155
You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
156
156
157
157
```sh
158
-
oc config set OCO_MODEL=gpt-4
158
+
oco config set OCO_MODEL=gpt-4
159
159
```
160
160
161
161
Make sure you do lowercase `gpt-4` and you have API access to the 4th model. Even if you have ChatGPT+ it doesn't necessarily mean that you have API access to GPT-4.
@@ -166,25 +166,25 @@ To globally specify the language used to generate commit messages:
166
166
167
167
```sh
168
168
# de, German ,Deutsch
169
-
oc config set OCO_LANGUAGE=de
170
-
oc config set OCO_LANGUAGE=German
171
-
oc config set OCO_LANGUAGE=Deutsch
169
+
oco config set OCO_LANGUAGE=de
170
+
oco config set OCO_LANGUAGE=German
171
+
oco config set OCO_LANGUAGE=Deutsch
172
172
173
173
# fr, French, française
174
-
oc config set OCO_LANGUAGE=fr
175
-
oc config set OCO_LANGUAGE=French
176
-
oc config set OCO_LANGUAGE=française
174
+
oco config set OCO_LANGUAGE=fr
175
+
oco config set OCO_LANGUAGE=French
176
+
oco config set OCO_LANGUAGE=française
177
177
```
178
178
179
-
The default language set is **English**
179
+
The default language set is **English**
180
180
All available languages are currently listed in the [i18n](https://github.com/di-sukharev/opencommit/tree/master/src/i18n) folder
181
181
182
182
### Git flags
183
183
184
-
The `opencommit` or `oc` commands can be used in place of the `git commit -m "${generatedMessage}"` command. This means that any regular flags that are used with the `git commit` command will also be applied when using `opencommit` or `oc`.
184
+
The `opencommit` or `oco` commands can be used in place of the `git commit -m "${generatedMessage}"` command. This means that any regular flags that are used with the `git commit` command will also be applied when using `opencommit` or `oco`.
185
185
186
186
```sh
187
-
oc --no-verify
187
+
oco --no-verify
188
188
```
189
189
190
190
is translated to :
@@ -213,13 +213,13 @@ You can set OpenCommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/gi
0 commit comments