opencommit 3.0.3 → 3.0.5
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 +18 -4
- package/out/cli.cjs +3461 -3403
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -2,13 +2,12 @@
|
|
|
2
2
|
<div>
|
|
3
3
|
<img src=".github/logo-grad.svg" alt="OpenCommit logo"/>
|
|
4
4
|
<h1 align="center">OpenCommit</h1>
|
|
5
|
-
<h4 align="center">Follow the bird <a href="https://twitter.com/
|
|
5
|
+
<h4 align="center">Follow the bird <a href="https://twitter.com/_sukharev_"><img src="https://img.shields.io/twitter/follow/_sukharev_?style=flat&label=_sukharev_&logo=twitter&color=0bf&logoColor=fff" align="center"></a>
|
|
6
6
|
</div>
|
|
7
7
|
<h2>Auto-generate meaningful commits in 1 second</h2>
|
|
8
8
|
<p>Killing lame commits with AI 🤯🔫</p>
|
|
9
9
|
<a href="https://www.npmjs.com/package/opencommit"><img src="https://img.shields.io/npm/v/opencommit" alt="Current version"></a>
|
|
10
|
-
<h4 align="center"
|
|
11
|
-
</h4>
|
|
10
|
+
<h4 align="center"><a href="https://twitter.com/_sukharev_/status/1683448136973582336">🪩 Winner of GitHub 2023 HACKATHON 🪩</a></h4>
|
|
12
11
|
</div>
|
|
13
12
|
|
|
14
13
|
---
|
|
@@ -29,6 +28,8 @@ You can use OpenCommit by simply running it via the CLI like this `oco`. 2 secon
|
|
|
29
28
|
npm install -g opencommit
|
|
30
29
|
```
|
|
31
30
|
|
|
31
|
+
Alternatively run it via `npx opencommit` or `bunx opencommit`
|
|
32
|
+
|
|
32
33
|
MacOS may ask to run the command with `sudo` when installing a package globally.
|
|
33
34
|
|
|
34
35
|
2. Get your API key from [OpenAI](https://platform.openai.com/account/api-keys). Make sure that you add your payment details, so the API works.
|
|
@@ -57,6 +58,17 @@ git add <files...>
|
|
|
57
58
|
oco
|
|
58
59
|
```
|
|
59
60
|
|
|
61
|
+
You can also run it with local model through ollama:
|
|
62
|
+
|
|
63
|
+
- install and start ollama
|
|
64
|
+
- run `ollama run mistral` (do this only once, to pull model)
|
|
65
|
+
- run (in your project directory):
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
git add <files...>
|
|
69
|
+
AI_PROVIDER='ollama' opencommit
|
|
70
|
+
```
|
|
71
|
+
|
|
60
72
|
## Configuration
|
|
61
73
|
|
|
62
74
|
### Local per repo configuration
|
|
@@ -332,4 +344,6 @@ You pay for your requests to OpenAI API on your own.
|
|
|
332
344
|
|
|
333
345
|
OpenCommit stores your key locally.
|
|
334
346
|
|
|
335
|
-
OpenCommit by default uses
|
|
347
|
+
OpenCommit by default uses 3.5-turbo-16k model, it should not exceed $0.10 per casual working day.
|
|
348
|
+
|
|
349
|
+
You may switch to gpt-4, it's better, but more expensive.
|