3.0.11

fix(githook.ts): update error message to include command example for better user guidance
build
2026-01-12 23:28:16 -05:00 · 2024-03-03 20:02:21 +08:00 · 2024-03-03 19:58:23 +08:00 · 2024-03-03 19:57:37 +08:00 · 2024-03-03 19:56:53 +08:00 · 2024-03-03 19:44:31 +08:00
22 changed files with 3441 additions and 3337 deletions
--- a/.github/workflows/stale.yml
+++ b/.github/workflows/stale.yml
@@ -1,28 +0,0 @@
-# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
-#
-# You can adjust the behavior by modifying this file.
-# For more information, see:
-# https://github.com/actions/stale
-name: Mark stale issues and pull requests
-
-on:
-  schedule:
-  - cron: '27 21 * * *'
-
-jobs:
-  stale:
-
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-
-    steps:
-    - uses: actions/stale@v5
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        days-before-stale: 40
-        stale-issue-message: 'Stale issue message'
-        stale-pr-message: 'Stale pull request message'
-        stale-issue-label: 'no-issue-activity'
-        stale-pr-label: 'no-pr-activity'
--- a/README.md
+++ b/README.md
@@ -2,13 +2,12 @@
  <div>
    <img src=".github/logo-grad.svg" alt="OpenCommit logo"/>
    <h1 align="center">OpenCommit</h1>
-    <h4 align="center">Follow the bird <a href="https://twitter.com/io_Y_oi"><img src="https://img.shields.io/twitter/follow/io_Y_oi?style=flat&label=io_Y_oi&logo=twitter&color=0bf&logoColor=fff" align="center"></a>
+    <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>
  </div>
 	<h2>Auto-generate meaningful commits in 1 second</h2>
 	<p>Killing lame commits with AI 🤯🔫</p>
 	<a href="https://www.npmjs.com/package/opencommit"><img src="https://img.shields.io/npm/v/opencommit" alt="Current version"></a>
-  <h4 align="center">🪩 Winner of GitHub 2023 HACKATHON <a href="https://twitter.com/io_Y_oi/status/1683448136973582336"><img style="width:14px; height:14px; margin-top: -4px" src=".github/github-mark-white.png" align="center"></a>
-  </h4>
+  <h4 align="center">🪩 Winner of <a href="https://twitter.com/_sukharev_/status/1683448136973582336">GitHub 2023 hackathon</a> 🪩</h4>
 </div>

 ---
@@ -29,6 +28,10 @@ You can use OpenCommit by simply running it via the CLI like this `oco`. 2 secon
   npm install -g opencommit
   ```

+   Alternatively run it via `npx opencommit` or `bunx opencommit`
+
+   MacOS may ask to run the command with `sudo` when installing a package globally.
+
 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.

 3. Set the key to OpenCommit config:
@@ -55,6 +58,30 @@ git add <files...>
 oco
 ```

+Link to the GitMoji specification: https://gitmoji.dev/
+
+You can also run it with local model through ollama:
+
+- install and start ollama
+- run `ollama run mistral` (do this only once, to pull model)
+- run (in your project directory):
+
+```sh
+git add <files...>
+AI_PROVIDER='ollama' opencommit
+```
+
+### Flags
+There are multiple optional flags that can be used with the `oco` command:
+
+#### Use Full GitMoji Specification
+This flag can only be used if the `OCO_EMOJI` configuration item is set to `true`. This flag allows users to use all emojis in the GitMoji specification, By default, the GitMoji full specification is set to `false`, which only includes 10 emojis (🐛✨📝🚀✅♻️⬆️🔧🌐💡).
+This is due to limit the number of tokens sent in each request. However, if you would like to use the full GitMoji specification, you can use the `--fgm` flag.
+
+```
+oco --fgm
+```
+  
 ## Configuration

 ### Local per repo configuration
@@ -63,7 +90,8 @@ Create a `.env` file and add OpenCommit config variables there like this:

 ```env
 OCO_OPENAI_API_KEY=<your OpenAI API token>
-OCO_OPENAI_MAX_TOKENS=<max response tokens from OpenAI API>
+OCO_TOKENS_MAX_INPUT=<max model token limit (default: 4096)>
+OCO_TOKENS_MAX_OUTPUT=<max response tokens (default: 500)>
 OCO_OPENAI_BASE_PATH=<may be used to set proxy path to OpenAI api>
 OCO_DESCRIPTION=<postface a message with ~3 sentences description of the changes>
 OCO_EMOJI=<boolean, add GitMoji>
@@ -111,6 +139,12 @@ or for as a cheaper option:
 oco config set OCO_MODEL=gpt-3.5-turbo
 ```

+or for GPT-4 Turbo (Preview) which is more capable, has knowledge of world events up to April 2023, a 128k context window and 2-3x cheaper vs GPT-4:
+
+```sh
+oco config set OCO_MODEL=gpt-4-1106-preview
+```
+
 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.

 ### Locale configuration
@@ -309,7 +343,8 @@ jobs:
          OCO_OPENAI_API_KEY: ${{ secrets.OCO_OPENAI_API_KEY }}

          # customization
-          OCO_OPENAI_MAX_TOKENS: 500
+          OCO_TOKENS_MAX_INPUT: 4096
+          OCO_TOKENS_MAX_OUTPUT: 500
          OCO_OPENAI_BASE_PATH: ''
          OCO_DESCRIPTION: false
          OCO_EMOJI: false
@@ -330,4 +365,6 @@ You pay for your requests to OpenAI API on your own.

 OpenCommit stores your key locally.

-OpenCommit by default uses ChatGPT (3.5-turbo-16k) official model, which is a lot cheaper than gpt-4.
+OpenCommit by default uses 3.5-turbo-16k model, it should not exceed $0.10 per casual working day.
+
+You may switch to gpt-4, it's better, but more expensive.
--- a/out/cli.cjs
+++ b/out/cli.cjs
--- a/out/github-action.cjs
+++ b/out/github-action.cjs
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
  "name": "opencommit",
-  "version": "2.4.2",
+  "version": "3.0.11",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "opencommit",
-      "version": "2.4.2",
+      "version": "3.0.11",
      "license": "MIT",
      "dependencies": {
        "@actions/core": "^1.10.0",
@@ -16,6 +16,7 @@
        "@dqbd/tiktoken": "^1.0.2",
        "@octokit/webhooks-schemas": "^6.11.0",
        "@octokit/webhooks-types": "^6.11.0",
+        "ai": "^2.2.14",
        "axios": "^1.3.4",
        "chalk": "^5.2.0",
        "cleye": "^1.3.2",
@@ -151,6 +152,31 @@
      "resolved": "https://registry.npmjs.org/@actions/io/-/io-1.1.3.tgz",
      "integrity": "sha512-wi9JjgKLYS7U/z8PPbco+PvTb/nRWjeoFlJ1Qer83k/3C5PHQi28hiVdeE2kHXmIL99mQFawx8qt/JPjZilJ8Q=="
    },
+    "node_modules/@ampproject/remapping": {
+      "version": "2.2.1",
+      "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.2.1.tgz",
+      "integrity": "sha512-lFMjJTrFL3j7L9yBxwYfCq2k6qqwHyzuUl/XBnif78PWTJYyL/dfowQHWE3sp6U6ZzqWiiIZnpTMO96zhkjwtg==",
+      "peer": true,
+      "dependencies": {
+        "@jridgewell/gen-mapping": "^0.3.0",
+        "@jridgewell/trace-mapping": "^0.3.9"
+      },
+      "engines": {
+        "node": ">=6.0.0"
+      }
+    },
+    "node_modules/@babel/parser": {
+      "version": "7.23.0",
+      "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.23.0.tgz",
+      "integrity": "sha512-vvPKKdMemU85V9WE/l5wZEmImpCtLqbnTvqDS2U1fJ96KrxoW7KrXhNsNCblQlg8Ck4b85yxdTyelsMUgFUXiw==",
+      "peer": true,
+      "bin": {
+        "parser": "bin/babel-parser.js"
+      },
+      "engines": {
+        "node": ">=6.0.0"
+      }
+    },
    "node_modules/@clack/core": {
      "version": "0.3.2",
      "resolved": "https://registry.npmjs.org/@clack/core/-/core-0.3.2.tgz",
@@ -342,26 +368,46 @@
      "integrity": "sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA==",
      "dev": true
    },
+    "node_modules/@jridgewell/gen-mapping": {
+      "version": "0.3.3",
+      "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.3.tgz",
+      "integrity": "sha512-HLhSWOLRi875zjjMG/r+Nv0oCW8umGb0BgEhyX3dDX3egwZtB8PqLnjz3yedt8R5StBrzcg4aBpnh8UA9D1BoQ==",
+      "peer": true,
+      "dependencies": {
+        "@jridgewell/set-array": "^1.0.1",
+        "@jridgewell/sourcemap-codec": "^1.4.10",
+        "@jridgewell/trace-mapping": "^0.3.9"
+      },
+      "engines": {
+        "node": ">=6.0.0"
+      }
+    },
    "node_modules/@jridgewell/resolve-uri": {
      "version": "3.1.0",
      "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.0.tgz",
      "integrity": "sha512-F2msla3tad+Mfht5cJq7LSXcdudKTWCVYUgw6pLFOOHSTtZlj6SWNYAp+AhuqLmWdBO2X5hPrLcu8cVP8fy28w==",
-      "dev": true,
+      "engines": {
+        "node": ">=6.0.0"
+      }
+    },
+    "node_modules/@jridgewell/set-array": {
+      "version": "1.1.2",
+      "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.1.2.tgz",
+      "integrity": "sha512-xnkseuNADM0gt2bs+BvhO0p78Mk762YnZdsuzFV018NoG1Sj1SCQvpSqa7XUaTam5vAGasABV9qXASMKnFMwMw==",
+      "peer": true,
      "engines": {
        "node": ">=6.0.0"
      }
    },
    "node_modules/@jridgewell/sourcemap-codec": {
-      "version": "1.4.14",
-      "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.14.tgz",
-      "integrity": "sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==",
-      "dev": true
+      "version": "1.4.15",
+      "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz",
+      "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg=="
    },
    "node_modules/@jridgewell/trace-mapping": {
      "version": "0.3.9",
      "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz",
      "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==",
-      "dev": true,
      "dependencies": {
        "@jridgewell/resolve-uri": "^3.0.3",
        "@jridgewell/sourcemap-codec": "^1.4.10"
@@ -651,6 +697,12 @@
      "integrity": "sha512-yOlFc+7UtL/89t2ZhjPvvB/DeAr3r+Dq58IgzsFkOAvVC6NMJXmCGjbptdXdR9qsX7pKcTL+s87FtYREi2dEEQ==",
      "dev": true
    },
+    "node_modules/@types/estree": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.2.tgz",
+      "integrity": "sha512-VeiPZ9MMwXjO32/Xu7+OwflfmeoRwkE/qzndw42gGtgJwZopBnzy2gD//NN1+go1mADzkDcqf/KnFRSjTJ8xJA==",
+      "peer": true
+    },
    "node_modules/@types/ini": {
      "version": "1.3.31",
      "resolved": "https://registry.npmjs.org/@types/ini/-/ini-1.3.31.tgz",
@@ -882,11 +934,140 @@
        "url": "https://opencollective.com/typescript-eslint"
      }
    },
+    "node_modules/@vue/compiler-core": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/@vue/compiler-core/-/compiler-core-3.3.4.tgz",
+      "integrity": "sha512-cquyDNvZ6jTbf/+x+AgM2Arrp6G4Dzbb0R64jiG804HRMfRiFXWI6kqUVqZ6ZR0bQhIoQjB4+2bhNtVwndW15g==",
+      "peer": true,
+      "dependencies": {
+        "@babel/parser": "^7.21.3",
+        "@vue/shared": "3.3.4",
+        "estree-walker": "^2.0.2",
+        "source-map-js": "^1.0.2"
+      }
+    },
+    "node_modules/@vue/compiler-core/node_modules/estree-walker": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz",
+      "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==",
+      "peer": true
+    },
+    "node_modules/@vue/compiler-dom": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/@vue/compiler-dom/-/compiler-dom-3.3.4.tgz",
+      "integrity": "sha512-wyM+OjOVpuUukIq6p5+nwHYtj9cFroz9cwkfmP9O1nzH68BenTTv0u7/ndggT8cIQlnBeOo6sUT/gvHcIkLA5w==",
+      "peer": true,
+      "dependencies": {
+        "@vue/compiler-core": "3.3.4",
+        "@vue/shared": "3.3.4"
+      }
+    },
+    "node_modules/@vue/compiler-sfc": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/@vue/compiler-sfc/-/compiler-sfc-3.3.4.tgz",
+      "integrity": "sha512-6y/d8uw+5TkCuzBkgLS0v3lSM3hJDntFEiUORM11pQ/hKvkhSKZrXW6i69UyXlJQisJxuUEJKAWEqWbWsLeNKQ==",
+      "peer": true,
+      "dependencies": {
+        "@babel/parser": "^7.20.15",
+        "@vue/compiler-core": "3.3.4",
+        "@vue/compiler-dom": "3.3.4",
+        "@vue/compiler-ssr": "3.3.4",
+        "@vue/reactivity-transform": "3.3.4",
+        "@vue/shared": "3.3.4",
+        "estree-walker": "^2.0.2",
+        "magic-string": "^0.30.0",
+        "postcss": "^8.1.10",
+        "source-map-js": "^1.0.2"
+      }
+    },
+    "node_modules/@vue/compiler-sfc/node_modules/estree-walker": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz",
+      "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==",
+      "peer": true
+    },
+    "node_modules/@vue/compiler-ssr": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/@vue/compiler-ssr/-/compiler-ssr-3.3.4.tgz",
+      "integrity": "sha512-m0v6oKpup2nMSehwA6Uuu+j+wEwcy7QmwMkVNVfrV9P2qE5KshC6RwOCq8fjGS/Eak/uNb8AaWekfiXxbBB6gQ==",
+      "peer": true,
+      "dependencies": {
+        "@vue/compiler-dom": "3.3.4",
+        "@vue/shared": "3.3.4"
+      }
+    },
+    "node_modules/@vue/reactivity": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/@vue/reactivity/-/reactivity-3.3.4.tgz",
+      "integrity": "sha512-kLTDLwd0B1jG08NBF3R5rqULtv/f8x3rOFByTDz4J53ttIQEDmALqKqXY0J+XQeN0aV2FBxY8nJDf88yvOPAqQ==",
+      "peer": true,
+      "dependencies": {
+        "@vue/shared": "3.3.4"
+      }
+    },
+    "node_modules/@vue/reactivity-transform": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/@vue/reactivity-transform/-/reactivity-transform-3.3.4.tgz",
+      "integrity": "sha512-MXgwjako4nu5WFLAjpBnCj/ieqcjE2aJBINUNQzkZQfzIZA4xn+0fV1tIYBJvvva3N3OvKGofRLvQIwEQPpaXw==",
+      "peer": true,
+      "dependencies": {
+        "@babel/parser": "^7.20.15",
+        "@vue/compiler-core": "3.3.4",
+        "@vue/shared": "3.3.4",
+        "estree-walker": "^2.0.2",
+        "magic-string": "^0.30.0"
+      }
+    },
+    "node_modules/@vue/reactivity-transform/node_modules/estree-walker": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz",
+      "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==",
+      "peer": true
+    },
+    "node_modules/@vue/runtime-core": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/@vue/runtime-core/-/runtime-core-3.3.4.tgz",
+      "integrity": "sha512-R+bqxMN6pWO7zGI4OMlmvePOdP2c93GsHFM/siJI7O2nxFRzj55pLwkpCedEY+bTMgp5miZ8CxfIZo3S+gFqvA==",
+      "peer": true,
+      "dependencies": {
+        "@vue/reactivity": "3.3.4",
+        "@vue/shared": "3.3.4"
+      }
+    },
+    "node_modules/@vue/runtime-dom": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/@vue/runtime-dom/-/runtime-dom-3.3.4.tgz",
+      "integrity": "sha512-Aj5bTJ3u5sFsUckRghsNjVTtxZQ1OyMWCr5dZRAPijF/0Vy4xEoRCwLyHXcj4D0UFbJ4lbx3gPTgg06K/GnPnQ==",
+      "peer": true,
+      "dependencies": {
+        "@vue/runtime-core": "3.3.4",
+        "@vue/shared": "3.3.4",
+        "csstype": "^3.1.1"
+      }
+    },
+    "node_modules/@vue/server-renderer": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/@vue/server-renderer/-/server-renderer-3.3.4.tgz",
+      "integrity": "sha512-Q6jDDzR23ViIb67v+vM1Dqntu+HUexQcsWKhhQa4ARVzxOY2HbC7QRW/ggkDBd5BU+uM1sV6XOAP0b216o34JQ==",
+      "peer": true,
+      "dependencies": {
+        "@vue/compiler-ssr": "3.3.4",
+        "@vue/shared": "3.3.4"
+      },
+      "peerDependencies": {
+        "vue": "3.3.4"
+      }
+    },
+    "node_modules/@vue/shared": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/@vue/shared/-/shared-3.3.4.tgz",
+      "integrity": "sha512-7OjdcV8vQ74eiz1TZLzZP4JwqM5fA94K6yntPS5Z25r9HDuGNzaGdgvwKYq6S+MxwF0TFRwe50fIR/MYnakdkQ==",
+      "peer": true
+    },
    "node_modules/acorn": {
-      "version": "8.8.2",
-      "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.2.tgz",
-      "integrity": "sha512-xjIYgE8HBrkpd/sJqOGNspf8uHG+NOHGOw6a/Urj8taM2EXfdNAH2oFcPeIFfsv3+kz/mJrS5VuMqbNLjCa2vw==",
-      "dev": true,
+      "version": "8.10.0",
+      "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.10.0.tgz",
+      "integrity": "sha512-F0SAmZ8iUtS//m8DmCTA0jlh6TDKkHQyK6xc6V4KDTyZKA9dnvX9/3sRTVQrWm79glUAZbnmmNcdYwUIHWVybw==",
      "bin": {
        "acorn": "bin/acorn"
      },
@@ -912,6 +1093,43 @@
        "node": ">=0.4.0"
      }
    },
+    "node_modules/ai": {
+      "version": "2.2.14",
+      "resolved": "https://registry.npmjs.org/ai/-/ai-2.2.14.tgz",
+      "integrity": "sha512-4kL2iYPVhH1pl6jJFIJCYcgx5mHzGOmdwiSYWVadmSkNOxKqokgevHyJKiyL9B9DjlreM9cDqkQop56Hdfkb0w==",
+      "dependencies": {
+        "eventsource-parser": "1.0.0",
+        "nanoid": "3.3.6",
+        "solid-swr-store": "0.10.7",
+        "sswr": "2.0.0",
+        "swr": "2.2.0",
+        "swr-store": "0.10.6",
+        "swrv": "1.0.4"
+      },
+      "engines": {
+        "node": ">=14.6"
+      },
+      "peerDependencies": {
+        "react": "^18.2.0",
+        "solid-js": "^1.7.7",
+        "svelte": "^3.0.0 || ^4.0.0",
+        "vue": "^3.3.4"
+      },
+      "peerDependenciesMeta": {
+        "react": {
+          "optional": true
+        },
+        "solid-js": {
+          "optional": true
+        },
+        "svelte": {
+          "optional": true
+        },
+        "vue": {
+          "optional": true
+        }
+      }
+    },
    "node_modules/ajv": {
      "version": "6.12.6",
      "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
@@ -985,6 +1203,15 @@
      "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
      "dev": true
    },
+    "node_modules/aria-query": {
+      "version": "5.3.0",
+      "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.0.tgz",
+      "integrity": "sha512-b0P0sZPKtyu8HkeRAfCq0IfURZK+SuwMjY1UXGBU27wpAiTwQAIlq56IbIO+ytk/JjS1fMR14ee5WBBfKi5J6A==",
+      "peer": true,
+      "dependencies": {
+        "dequal": "^2.0.3"
+      }
+    },
    "node_modules/array-union": {
      "version": "2.1.0",
      "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz",
@@ -1009,6 +1236,15 @@
        "proxy-from-env": "^1.1.0"
      }
    },
+    "node_modules/axobject-query": {
+      "version": "3.2.1",
+      "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-3.2.1.tgz",
+      "integrity": "sha512-jsyHu61e6N4Vbz/v18DHwWYKK0bSWLqn47eeDSKPB7m8tqMHF9YJ+mhIk2lVteyZrY8tnSj/jHOv4YiTCuCJgg==",
+      "peer": true,
+      "dependencies": {
+        "dequal": "^2.0.3"
+      }
+    },
    "node_modules/balanced-match": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
@@ -1172,6 +1408,19 @@
        "node": ">=0.8"
      }
    },
+    "node_modules/code-red": {
+      "version": "1.0.4",
+      "resolved": "https://registry.npmjs.org/code-red/-/code-red-1.0.4.tgz",
+      "integrity": "sha512-7qJWqItLA8/VPVlKJlFXU+NBlo/qyfs39aJcuMT/2ere32ZqvF5OSxgdM5xOfJJ7O429gg2HM47y8v9P+9wrNw==",
+      "peer": true,
+      "dependencies": {
+        "@jridgewell/sourcemap-codec": "^1.4.15",
+        "@types/estree": "^1.0.1",
+        "acorn": "^8.10.0",
+        "estree-walker": "^3.0.3",
+        "periscopic": "^3.1.0"
+      }
+    },
    "node_modules/color-convert": {
      "version": "2.0.1",
      "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
@@ -1232,6 +1481,25 @@
      "integrity": "sha512-VxBKmeNcqQdiUQUW2Tzq0t377b54N2bMtXO/qiLa+6eRRmmC4qT3D4OnTGoT/U6O9aklQ/jTwbOtRMTTY8G0Ig==",
      "deprecated": "This package is no longer supported. It's now a built-in Node module. If you've depended on crypto, you should switch to the one that's built-in."
    },
+    "node_modules/css-tree": {
+      "version": "2.3.1",
+      "resolved": "https://registry.npmjs.org/css-tree/-/css-tree-2.3.1.tgz",
+      "integrity": "sha512-6Fv1DV/TYw//QF5IzQdqsNDjx/wc8TrMBZsqjL9eW01tWb7R7k/mq+/VXfJCl7SoD5emsJop9cOByJZfs8hYIw==",
+      "peer": true,
+      "dependencies": {
+        "mdn-data": "2.0.30",
+        "source-map-js": "^1.0.1"
+      },
+      "engines": {
+        "node": "^10 || ^12.20.0 || ^14.13.0 || >=15.0.0"
+      }
+    },
+    "node_modules/csstype": {
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.2.tgz",
+      "integrity": "sha512-I7K1Uu0MBPzaFKg4nI5Q7Vs2t+3gWWW648spaF+Rg7pI9ds18Ugn+lvg4SHczUdKlHI5LWBXyqfS8+DufyBsgQ==",
+      "peer": true
+    },
    "node_modules/debug": {
      "version": "4.3.4",
      "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
@@ -1279,6 +1547,14 @@
      "resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz",
      "integrity": "sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ=="
    },
+    "node_modules/dequal": {
+      "version": "2.0.3",
+      "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz",
+      "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==",
+      "engines": {
+        "node": ">=6"
+      }
+    },
    "node_modules/diff": {
      "version": "4.0.2",
      "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz",
@@ -1927,6 +2203,15 @@
        "node": ">=4.0"
      }
    },
+    "node_modules/estree-walker": {
+      "version": "3.0.3",
+      "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz",
+      "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==",
+      "peer": true,
+      "dependencies": {
+        "@types/estree": "^1.0.0"
+      }
+    },
    "node_modules/esutils": {
      "version": "2.0.3",
      "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz",
@@ -1936,6 +2221,14 @@
        "node": ">=0.10.0"
      }
    },
+    "node_modules/eventsource-parser": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/eventsource-parser/-/eventsource-parser-1.0.0.tgz",
+      "integrity": "sha512-9jgfSCa3dmEme2ES3mPByGXfgZ87VbP97tng1G2nWwWx6bV2nYxm2AWCrbQjXToSe+yYlqaZNtxffR9IeQr95g==",
+      "engines": {
+        "node": ">=14.18"
+      }
+    },
    "node_modules/execa": {
      "version": "7.0.0",
      "resolved": "https://registry.npmjs.org/execa/-/execa-7.0.0.tgz",
@@ -2444,6 +2737,15 @@
        "node": ">=0.10.0"
      }
    },
+    "node_modules/is-reference": {
+      "version": "3.0.2",
+      "resolved": "https://registry.npmjs.org/is-reference/-/is-reference-3.0.2.tgz",
+      "integrity": "sha512-v3rht/LgVcsdZa3O2Nqs+NMowLOxeOm7Ay9+/ARQ2F+qEoANRcqrjAZKGN0v8ymUetZGgkp26LTnGT7H0Qo9Pg==",
+      "peer": true,
+      "dependencies": {
+        "@types/estree": "*"
+      }
+    },
    "node_modules/is-stream": {
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz",
@@ -2481,6 +2783,12 @@
        "url": "https://opencollective.com/js-sdsl"
      }
    },
+    "node_modules/js-tokens": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
+      "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==",
+      "peer": true
+    },
    "node_modules/js-yaml": {
      "version": "4.1.0",
      "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
@@ -2518,6 +2826,12 @@
        "node": ">= 0.8.0"
      }
    },
+    "node_modules/locate-character": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/locate-character/-/locate-character-3.0.0.tgz",
+      "integrity": "sha512-SW13ws7BjaeJ6p7Q6CO2nchbYEc3X3J6WrmTTDto7yMPqVSZTUyY5Tjbid+Ab8gLnATtygYtiDIJGQRRn2ZOiA==",
+      "peer": true
+    },
    "node_modules/locate-path": {
      "version": "6.0.0",
      "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz",
@@ -2559,6 +2873,18 @@
        "url": "https://github.com/sponsors/sindresorhus"
      }
    },
+    "node_modules/loose-envify": {
+      "version": "1.4.0",
+      "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz",
+      "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==",
+      "peer": true,
+      "dependencies": {
+        "js-tokens": "^3.0.0 || ^4.0.0"
+      },
+      "bin": {
+        "loose-envify": "cli.js"
+      }
+    },
    "node_modules/lru-cache": {
      "version": "6.0.0",
      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",
@@ -2571,12 +2897,30 @@
        "node": ">=10"
      }
    },
+    "node_modules/magic-string": {
+      "version": "0.30.4",
+      "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.4.tgz",
+      "integrity": "sha512-Q/TKtsC5BPm0kGqgBIF9oXAs/xEf2vRKiIB4wCRQTJOQIByZ1d+NnUOotvJOvNpi5RNIgVOMC3pOuaP1ZTDlVg==",
+      "peer": true,
+      "dependencies": {
+        "@jridgewell/sourcemap-codec": "^1.4.15"
+      },
+      "engines": {
+        "node": ">=12"
+      }
+    },
    "node_modules/make-error": {
      "version": "1.3.6",
      "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz",
      "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==",
      "dev": true
    },
+    "node_modules/mdn-data": {
+      "version": "2.0.30",
+      "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.30.tgz",
+      "integrity": "sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==",
+      "peer": true
+    },
    "node_modules/merge-stream": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz",
@@ -2657,6 +3001,23 @@
      "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz",
      "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA=="
    },
+    "node_modules/nanoid": {
+      "version": "3.3.6",
+      "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.6.tgz",
+      "integrity": "sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/ai"
+        }
+      ],
+      "bin": {
+        "nanoid": "bin/nanoid.cjs"
+      },
+      "engines": {
+        "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1"
+      }
+    },
    "node_modules/natural-compare": {
      "version": "1.4.0",
      "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz",
@@ -2901,6 +3262,17 @@
        "node": ">=8"
      }
    },
+    "node_modules/periscopic": {
+      "version": "3.1.0",
+      "resolved": "https://registry.npmjs.org/periscopic/-/periscopic-3.1.0.tgz",
+      "integrity": "sha512-vKiQ8RRtkl9P+r/+oefh25C3fhybptkHKCZSPlcXiJux2tJF55GnEj3BVn4A5gKfq9NWWXXrxkHBwVPUfH0opw==",
+      "peer": true,
+      "dependencies": {
+        "@types/estree": "^1.0.0",
+        "estree-walker": "^3.0.0",
+        "is-reference": "^3.0.0"
+      }
+    },
    "node_modules/picocolors": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz",
@@ -2918,6 +3290,34 @@
        "url": "https://github.com/sponsors/jonschlinkert"
      }
    },
+    "node_modules/postcss": {
+      "version": "8.4.31",
+      "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.31.tgz",
+      "integrity": "sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ==",
+      "funding": [
+        {
+          "type": "opencollective",
+          "url": "https://opencollective.com/postcss/"
+        },
+        {
+          "type": "tidelift",
+          "url": "https://tidelift.com/funding/github/npm/postcss"
+        },
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/ai"
+        }
+      ],
+      "peer": true,
+      "dependencies": {
+        "nanoid": "^3.3.6",
+        "picocolors": "^1.0.0",
+        "source-map-js": "^1.0.2"
+      },
+      "engines": {
+        "node": "^10 || ^12 || >=14"
+      }
+    },
    "node_modules/prelude-ls": {
      "version": "1.2.1",
      "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz",
@@ -2976,6 +3376,18 @@
        }
      ]
    },
+    "node_modules/react": {
+      "version": "18.2.0",
+      "resolved": "https://registry.npmjs.org/react/-/react-18.2.0.tgz",
+      "integrity": "sha512-/3IjMdb2L9QbBdWiW5e3P2/npwMBaU9mHCSCUzNln0ZCYbcfTsGbTJrU/kGemdH2IWmB2ioZ+zkxtmq6g09fGQ==",
+      "peer": true,
+      "dependencies": {
+        "loose-envify": "^1.1.0"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
    "node_modules/readable-stream": {
      "version": "3.6.2",
      "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz",
@@ -3150,6 +3562,15 @@
        "node": ">=10"
      }
    },
+    "node_modules/seroval": {
+      "version": "0.5.1",
+      "resolved": "https://registry.npmjs.org/seroval/-/seroval-0.5.1.tgz",
+      "integrity": "sha512-ZfhQVB59hmIauJG5Ydynupy8KHyr5imGNtdDhbZG68Ufh1Ynkv9KOYOAABf71oVbQxJ8VkWnMHAjEHE7fWkH5g==",
+      "peer": true,
+      "engines": {
+        "node": ">=10"
+      }
+    },
    "node_modules/shebang-command": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
@@ -3188,6 +3609,48 @@
        "node": ">=8"
      }
    },
+    "node_modules/solid-js": {
+      "version": "1.7.12",
+      "resolved": "https://registry.npmjs.org/solid-js/-/solid-js-1.7.12.tgz",
+      "integrity": "sha512-QoyoOUKu14iLoGxjxWFIU8+/1kLT4edQ7mZESFPonsEXZ//VJtPKD8Ud1aTKzotj+MNWmSs9YzK6TdY+fO9Eww==",
+      "peer": true,
+      "dependencies": {
+        "csstype": "^3.1.0",
+        "seroval": "^0.5.0"
+      }
+    },
+    "node_modules/solid-swr-store": {
+      "version": "0.10.7",
+      "resolved": "https://registry.npmjs.org/solid-swr-store/-/solid-swr-store-0.10.7.tgz",
+      "integrity": "sha512-A6d68aJmRP471aWqKKPE2tpgOiR5fH4qXQNfKIec+Vap+MGQm3tvXlT8n0I8UgJSlNAsSAUuw2VTviH2h3Vv5g==",
+      "engines": {
+        "node": ">=10"
+      },
+      "peerDependencies": {
+        "solid-js": "^1.2",
+        "swr-store": "^0.10"
+      }
+    },
+    "node_modules/source-map-js": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.0.2.tgz",
+      "integrity": "sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==",
+      "peer": true,
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/sswr": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/sswr/-/sswr-2.0.0.tgz",
+      "integrity": "sha512-mV0kkeBHcjcb0M5NqKtKVg/uTIYNlIIniyDfSGrSfxpEdM9C365jK0z55pl9K0xAkNTJi2OAOVFQpgMPUk+V0w==",
+      "dependencies": {
+        "swrev": "^4.0.0"
+      },
+      "peerDependencies": {
+        "svelte": "^4.0.0"
+      }
+    },
    "node_modules/string_decoder": {
      "version": "1.3.0",
      "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz",
@@ -3284,6 +3747,75 @@
        "node": ">=8"
      }
    },
+    "node_modules/svelte": {
+      "version": "4.2.1",
+      "resolved": "https://registry.npmjs.org/svelte/-/svelte-4.2.1.tgz",
+      "integrity": "sha512-LpLqY2Jr7cRxkrTc796/AaaoMLF/1ax7cto8Ot76wrvKQhrPmZ0JgajiWPmg9mTSDqO16SSLiD17r9MsvAPTmw==",
+      "peer": true,
+      "dependencies": {
+        "@ampproject/remapping": "^2.2.1",
+        "@jridgewell/sourcemap-codec": "^1.4.15",
+        "@jridgewell/trace-mapping": "^0.3.18",
+        "acorn": "^8.9.0",
+        "aria-query": "^5.3.0",
+        "axobject-query": "^3.2.1",
+        "code-red": "^1.0.3",
+        "css-tree": "^2.3.1",
+        "estree-walker": "^3.0.3",
+        "is-reference": "^3.0.1",
+        "locate-character": "^3.0.0",
+        "magic-string": "^0.30.0",
+        "periscopic": "^3.1.0"
+      },
+      "engines": {
+        "node": ">=16"
+      }
+    },
+    "node_modules/svelte/node_modules/@jridgewell/trace-mapping": {
+      "version": "0.3.19",
+      "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.19.tgz",
+      "integrity": "sha512-kf37QtfW+Hwx/buWGMPcR60iF9ziHa6r/CZJIHbmcm4+0qrXiVdxegAH0F6yddEVQ7zdkjcGCgCzUu+BcbhQxw==",
+      "peer": true,
+      "dependencies": {
+        "@jridgewell/resolve-uri": "^3.1.0",
+        "@jridgewell/sourcemap-codec": "^1.4.14"
+      }
+    },
+    "node_modules/swr": {
+      "version": "2.2.0",
+      "resolved": "https://registry.npmjs.org/swr/-/swr-2.2.0.tgz",
+      "integrity": "sha512-AjqHOv2lAhkuUdIiBu9xbuettzAzWXmCEcLONNKJRba87WAefz8Ca9d6ds/SzrPc235n1IxWYdhJ2zF3MNUaoQ==",
+      "dependencies": {
+        "use-sync-external-store": "^1.2.0"
+      },
+      "peerDependencies": {
+        "react": "^16.11.0 || ^17.0.0 || ^18.0.0"
+      }
+    },
+    "node_modules/swr-store": {
+      "version": "0.10.6",
+      "resolved": "https://registry.npmjs.org/swr-store/-/swr-store-0.10.6.tgz",
+      "integrity": "sha512-xPjB1hARSiRaNNlUQvWSVrG5SirCjk2TmaUyzzvk69SZQan9hCJqw/5rG9iL7xElHU784GxRPISClq4488/XVw==",
+      "dependencies": {
+        "dequal": "^2.0.3"
+      },
+      "engines": {
+        "node": ">=10"
+      }
+    },
+    "node_modules/swrev": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/swrev/-/swrev-4.0.0.tgz",
+      "integrity": "sha512-LqVcOHSB4cPGgitD1riJ1Hh4vdmITOp+BkmfmXRh4hSF/t7EnS4iD+SOTmq7w5pPm/SiPeto4ADbKS6dHUDWFA=="
+    },
+    "node_modules/swrv": {
+      "version": "1.0.4",
+      "resolved": "https://registry.npmjs.org/swrv/-/swrv-1.0.4.tgz",
+      "integrity": "sha512-zjEkcP8Ywmj+xOJW3lIT65ciY/4AL4e/Or7Gj0MzU3zBJNMdJiT8geVZhINavnlHRMMCcJLHhraLTAiDOTmQ9g==",
+      "peerDependencies": {
+        "vue": ">=3.2.26 < 4"
+      }
+    },
    "node_modules/terminal-columns": {
      "version": "1.4.1",
      "resolved": "https://registry.npmjs.org/terminal-columns/-/terminal-columns-1.4.1.tgz",
@@ -3467,6 +3999,14 @@
        "punycode": "^2.1.0"
      }
    },
+    "node_modules/use-sync-external-store": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/use-sync-external-store/-/use-sync-external-store-1.2.0.tgz",
+      "integrity": "sha512-eEgnFxGQ1Ife9bzYs6VLi8/4X6CObHMw9Qr9tPY43iKwsPw8xE8+EFsf/2cFZ5S3esXgpWgtSCtLNS41F+sKPA==",
+      "peerDependencies": {
+        "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
+      }
+    },
    "node_modules/util-deprecate": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
@@ -3486,6 +4026,19 @@
      "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==",
      "dev": true
    },
+    "node_modules/vue": {
+      "version": "3.3.4",
+      "resolved": "https://registry.npmjs.org/vue/-/vue-3.3.4.tgz",
+      "integrity": "sha512-VTyEYn3yvIeY1Py0WaYGZsXnz3y5UnGi62GjVEqvEGPl6nxbOrCXbVOTQWBEJUqAyTUk2uJ5JLVnYJ6ZzGbrSw==",
+      "peer": true,
+      "dependencies": {
+        "@vue/compiler-dom": "3.3.4",
+        "@vue/compiler-sfc": "3.3.4",
+        "@vue/runtime-dom": "3.3.4",
+        "@vue/server-renderer": "3.3.4",
+        "@vue/shared": "3.3.4"
+      }
+    },
    "node_modules/wcwidth": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz",
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "opencommit",
-  "version": "3.0.0",
+  "version": "3.0.11",
  "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
  "keywords": [
    "git",
@@ -12,7 +12,8 @@
    "aicommit",
    "aicommits",
    "gptcommit",
-    "commit"
+    "commit",
+    "ollama"
  ],
  "main": "cli.js",
  "bin": {
@@ -40,10 +41,11 @@
  "scripts": {
    "watch": "npm run -S build -- --sourcemap --watch",
    "start": "node ./out/cli.cjs",
+    "ollama:start": "OCO_AI_PROVIDER='ollama' node ./out/cli.cjs",
    "dev": "ts-node ./src/cli.ts",
    "build": "rimraf out && node esbuild.config.js",
    "build:push": "npm run build && git add . && git commit -m 'build' && git push",
-    "deploy": "npm run build:push && npm version patch && git push --tags && npm publish --tag latest",
+    "deploy": "npm version patch && npm run build:push && git push --tags && npm publish --tag latest",
    "lint": "eslint src --ext ts && tsc --noEmit",
    "format": "prettier --write src"
  },
@@ -69,6 +71,7 @@
    "@dqbd/tiktoken": "^1.0.2",
    "@octokit/webhooks-schemas": "^6.11.0",
    "@octokit/webhooks-types": "^6.11.0",
+    "ai": "^2.2.14",
    "axios": "^1.3.4",
    "chalk": "^5.2.0",
    "cleye": "^1.3.2",
--- a/src/cli.ts
+++ b/src/cli.ts
@@ -17,17 +17,19 @@ cli(
    version: packageJSON.version,
    name: 'opencommit',
    commands: [configCommand, hookCommand, commitlintConfigCommand],
-    flags: {},
+    flags: {
+      fgm: Boolean
+    },
    ignoreArgv: (type) => type === 'unknown-flag' || type === 'argument',
    help: { description: packageJSON.description }
  },
-  async () => {
+  async ({ flags }) => {
    await checkIsLatestVersion();

    if (await isHookCalled()) {
      prepareCommitMessageHook();
    } else {
-      commit(extraArgs);
+      commit(extraArgs, flags.fgm);
    }
  },
  extraArgs
--- a/src/commands/commit.ts
+++ b/src/commands/commit.ts
@@ -40,20 +40,27 @@ const checkMessageTemplate = (extraArgs: string[]): string | false => {

 const generateCommitMessageFromGitDiff = async (
  diff: string,
-  extraArgs: string[]
+  extraArgs: string[],
+  fullGitMojiSpec: boolean
 ): Promise<void> => {
  await assertGitRepo();
  const commitSpinner = spinner();
  commitSpinner.start('Generating the commit message');

  try {
-    let commitMessage = await generateCommitMessageByDiff(diff);
+    let commitMessage = await generateCommitMessageByDiff(
+      diff,
+      fullGitMojiSpec
+    );

    const messageTemplate = checkMessageTemplate(extraArgs);
    if (
      config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER &&
      typeof messageTemplate === 'string'
    ) {
+      const messageTemplateIndex = extraArgs.indexOf(messageTemplate);
+      extraArgs.splice(messageTemplateIndex, 1);
+
      commitMessage = messageTemplate.replace(
        config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
        commitMessage
@@ -154,7 +161,8 @@ ${chalk.grey('——————————————————')}`

 export async function commit(
  extraArgs: string[] = [],
-  isStageAllFlag: Boolean = false
+  isStageAllFlag: Boolean = false,
+  fullGitMojiSpec: boolean = false
 ) {
  if (isStageAllFlag) {
    const changedFiles = await getChangedFiles();
@@ -194,7 +202,7 @@ export async function commit(
      isStageAllAndCommitConfirmedByUser &&
      !isCancel(isStageAllAndCommitConfirmedByUser)
    ) {
-      await commit(extraArgs, true);
+      await commit(extraArgs, true, fullGitMojiSpec);
      process.exit(1);
    }

@@ -212,7 +220,7 @@ export async function commit(
      await gitAdd({ files });
    }

-    await commit(extraArgs, false);
+    await commit(extraArgs, false, fullGitMojiSpec);
    process.exit(1);
  }

@@ -225,7 +233,8 @@ export async function commit(
  const [, generateCommitError] = await trytm(
    generateCommitMessageFromGitDiff(
      await getDiff({ files: stagedFiles }),
-      extraArgs
+      extraArgs,
+      fullGitMojiSpec
    )
  );

--- a/src/commands/config.ts
+++ b/src/commands/config.ts
@@ -15,23 +15,28 @@ dotenv.config();

 export enum CONFIG_KEYS {
  OCO_OPENAI_API_KEY = 'OCO_OPENAI_API_KEY',
-  OCO_OPENAI_MAX_TOKENS = 'OCO_OPENAI_MAX_TOKENS',
+  OCO_TOKENS_MAX_INPUT = 'OCO_TOKENS_MAX_INPUT',
+  OCO_TOKENS_MAX_OUTPUT = 'OCO_TOKENS_MAX_OUTPUT',
  OCO_OPENAI_BASE_PATH = 'OCO_OPENAI_BASE_PATH',
  OCO_DESCRIPTION = 'OCO_DESCRIPTION',
  OCO_EMOJI = 'OCO_EMOJI',
  OCO_MODEL = 'OCO_MODEL',
  OCO_LANGUAGE = 'OCO_LANGUAGE',
  OCO_MESSAGE_TEMPLATE_PLACEHOLDER = 'OCO_MESSAGE_TEMPLATE_PLACEHOLDER',
-  OCO_PROMPT_MODULE = 'OCO_PROMPT_MODULE'
+  OCO_PROMPT_MODULE = 'OCO_PROMPT_MODULE',
+  OCO_AI_PROVIDER = 'OCO_AI_PROVIDER',
 }

-export const DEFAULT_MODEL_TOKEN_LIMIT = 4096;
-
 export enum CONFIG_MODES {
  get = 'get',
  set = 'set'
 }

+export enum DEFAULT_TOKEN_LIMITS {
+  DEFAULT_MAX_TOKENS_INPUT = 4096,
+  DEFAULT_MAX_TOKENS_OUTPUT = 500
+}
+
 const validateConfig = (
  key: string,
  condition: any,
@@ -47,8 +52,9 @@ const validateConfig = (
 };

 export const configValidators = {
-  [CONFIG_KEYS.OCO_OPENAI_API_KEY](value: any, config?: any) {
-    validateConfig(CONFIG_KEYS.OCO_OPENAI_API_KEY, value, 'Cannot be empty');
+  [CONFIG_KEYS.OCO_OPENAI_API_KEY](value: any, config: any = {}) {
+    //need api key unless running locally with ollama
+    validateConfig('API_KEY', value || config.OCO_AI_PROVIDER == 'ollama', 'You need to provide an API key');
    validateConfig(
      CONFIG_KEYS.OCO_OPENAI_API_KEY,
      value.startsWith('sk-'),
@@ -73,18 +79,37 @@ export const configValidators = {
    return value;
  },

-  [CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS](value: any) {
+  [CONFIG_KEYS.OCO_TOKENS_MAX_INPUT](value: any) {
    // If the value is a string, convert it to a number.
    if (typeof value === 'string') {
      value = parseInt(value);
      validateConfig(
-        CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS,
+        CONFIG_KEYS.OCO_TOKENS_MAX_INPUT,
        !isNaN(value),
        'Must be a number'
      );
    }
    validateConfig(
-      CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS,
+      CONFIG_KEYS.OCO_TOKENS_MAX_INPUT,
+      value ? typeof value === 'number' : undefined,
+      'Must be a number'
+    );
+
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT](value: any) {
+    // If the value is a string, convert it to a number.
+    if (typeof value === 'string') {
+      value = parseInt(value);
+      validateConfig(
+        CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT,
+        !isNaN(value),
+        'Must be a number'
+      );
+    }
+    validateConfig(
+      CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT,
      value ? typeof value === 'number' : undefined,
      'Must be a number'
    );
@@ -127,9 +152,10 @@ export const configValidators = {
        'gpt-3.5-turbo',
        'gpt-4',
        'gpt-3.5-turbo-16k',
-        'gpt-3.5-turbo-0613'
+        'gpt-3.5-turbo-0613',
+        'gpt-4-1106-preview'
      ].includes(value),
-      `${value} is not supported yet, use 'gpt-4', 'gpt-3.5-turbo-16k' (default), 'gpt-3.5-turbo-0613' or 'gpt-3.5-turbo'`
+      `${value} is not supported yet, use 'gpt-4', 'gpt-3.5-turbo-16k' (default), 'gpt-3.5-turbo-0613', 'gpt-3.5-turbo' or 'gpt-4-1106-preview'`
    );
    return value;
  },
@@ -150,7 +176,20 @@ export const configValidators = {
    );

    return value;
-  }
+  },
+
+  [CONFIG_KEYS.OCO_AI_PROVIDER](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_AI_PROVIDER,
+      [
+        '',
+        'openai',
+        'ollama'
+      ].includes(value),
+      `${value} is not supported yet, use 'ollama' or 'openai' (default)`
+    );
+    return value;
+  },
 };

 export type ConfigType = {
@@ -162,8 +201,11 @@ const configPath = pathJoin(homedir(), '.opencommit');
 export const getConfig = (): ConfigType | null => {
  const configFromEnv = {
    OCO_OPENAI_API_KEY: process.env.OCO_OPENAI_API_KEY,
-    OCO_OPENAI_MAX_TOKENS: process.env.OCO_OPENAI_MAX_TOKENS
-      ? Number(process.env.OCO_OPENAI_MAX_TOKENS)
+    OCO_TOKENS_MAX_INPUT: process.env.OCO_TOKENS_MAX_INPUT
+      ? Number(process.env.OCO_TOKENS_MAX_INPUT)
+      : undefined,
+    OCO_TOKENS_MAX_OUTPUT: process.env.OCO_TOKENS_MAX_OUTPUT
+      ? Number(process.env.OCO_TOKENS_MAX_OUTPUT)
      : undefined,
    OCO_OPENAI_BASE_PATH: process.env.OCO_OPENAI_BASE_PATH,
    OCO_DESCRIPTION: process.env.OCO_DESCRIPTION === 'true' ? true : false,
@@ -172,7 +214,8 @@ export const getConfig = (): ConfigType | null => {
    OCO_LANGUAGE: process.env.OCO_LANGUAGE || 'en',
    OCO_MESSAGE_TEMPLATE_PLACEHOLDER:
      process.env.OCO_MESSAGE_TEMPLATE_PLACEHOLDER || '$msg',
-    OCO_PROMPT_MODULE: process.env.OCO_PROMPT_MODULE || 'conventional-commit'
+    OCO_PROMPT_MODULE: process.env.OCO_PROMPT_MODULE || 'conventional-commit',
+    OCO_AI_PROVIDER: process.env.OCO_AI_PROVIDER || 'openai'
  };

  const configExists = existsSync(configPath);
@@ -198,9 +241,7 @@ export const getConfig = (): ConfigType | null => {

      config[configKey] = validValue;
    } catch (error) {
-      outro(
-        `'${configKey}' name is invalid, it should be either 'OCO_${configKey.toUpperCase()}' or it doesn't exist.`
-      );
+      outro(`Unknown '${configKey}' config option.`);
      outro(
        `Manually fix the '.env' file or global '~/.opencommit' config file.`
      );
--- a/src/commands/githook.ts
+++ b/src/commands/githook.ts
@@ -94,7 +94,7 @@ export const hookCommand = command(
      }

      throw new Error(
-        `Unsupported mode: ${mode}. Supported modes are: 'set' or 'unset'`
+        `Unsupported mode: ${mode}. Supported modes are: 'set' or 'unset', do: \`oco hook set\``
      );
    } catch (error) {
      outro(`${chalk.red('✖')} ${error}`);
--- a/src/engine/Engine.ts
+++ b/src/engine/Engine.ts
@@ -0,0 +1,7 @@
+import { ChatCompletionRequestMessage } from 'openai';
+
+export interface AiEngine {
+  generateCommitMessage(
+    messages: Array<ChatCompletionRequestMessage>
+  ): Promise<string | undefined>;
+}
--- a/src/engine/ollama.ts
+++ b/src/engine/ollama.ts
@@ -0,0 +1,36 @@
+import axios, { AxiosError } from 'axios';
+import { ChatCompletionRequestMessage } from 'openai';
+import { AiEngine } from './Engine';
+
+export class OllamaAi implements AiEngine {
+  async generateCommitMessage(
+    messages: Array<ChatCompletionRequestMessage>
+  ): Promise<string | undefined> {
+    const model = 'mistral'; // todo: allow other models
+
+    let prompt = messages.map((x) => x.content).join('\n');
+    //hoftix: local models are not so clever so im changing the prompt a bit...
+    prompt += 'Summarize above git diff in 10 words or less';
+
+    const url = 'http://localhost:11434/api/generate';
+    const p = {
+      model,
+      prompt,
+      stream: false
+    };
+    try {
+      const response = await axios.post(url, p, {
+        headers: {
+          'Content-Type': 'application/json'
+        }
+      });
+      const answer = response.data?.response;
+      return answer;
+    } catch (err: any) {
+      const message = err.response?.data?.error ?? err.message;
+      throw new Error('local model issues. details: ' + message);
+    }
+  }
+}
+
+export const ollamaAi = new OllamaAi();
--- a/src/engine/openAi.ts
+++ b/src/engine/openAi.ts
@@ -11,25 +11,30 @@ import { intro, outro } from '@clack/prompts';

 import {
  CONFIG_MODES,
-  DEFAULT_MODEL_TOKEN_LIMIT,
+  DEFAULT_TOKEN_LIMITS,
  getConfig
-} from './commands/config';
-import { GenerateCommitMessageErrorEnum } from './generateCommitMessageFromGitDiff';
-import { tokenCount } from './utils/tokenCount';
+} from '../commands/config';
+import { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitDiff';
+import { tokenCount } from '../utils/tokenCount';
+import { AiEngine } from './Engine';

 const config = getConfig();

-let maxTokens = config?.OCO_OPENAI_MAX_TOKENS;
+const MAX_TOKENS_OUTPUT = config?.OCO_TOKENS_MAX_OUTPUT || DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_OUTPUT;
+const MAX_TOKENS_INPUT = config?.OCO_TOKENS_MAX_INPUT || DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_INPUT;
 let basePath = config?.OCO_OPENAI_BASE_PATH;
-let apiKey = config?.OCO_OPENAI_API_KEY;
+let apiKey = config?.OCO_OPENAI_API_KEY

 const [command, mode] = process.argv.slice(2);

-if (!apiKey && command !== 'config' && mode !== CONFIG_MODES.set) {
+const isLocalModel = config?.OCO_AI_PROVIDER == 'ollama'
+
+
+if (!apiKey && command !== 'config' && mode !== CONFIG_MODES.set && !isLocalModel) {
  intro('opencommit');

  outro(
-    'OCO_OPENAI_API_KEY is not set, please run `oco config set OCO_OPENAI_API_KEY=<your token>. Make sure you add payment details, so API works.`'
+    'OCO_OPENAI_API_KEY is not set, please run `oco config set OCO_OPENAI_API_KEY=<your token> . If you are using GPT, make sure you add payment details, so API works.`'
  );
  outro(
    'For help look into README https://github.com/di-sukharev/opencommit#setup'
@@ -40,7 +45,7 @@ if (!apiKey && command !== 'config' && mode !== CONFIG_MODES.set) {

 const MODEL = config?.OCO_MODEL || 'gpt-3.5-turbo';

-class OpenAi {
+class OpenAi implements AiEngine {
  private openAiApiConfiguration = new OpenAiApiConfiguration({
    apiKey: apiKey
  });
@@ -61,14 +66,14 @@ class OpenAi {
      messages,
      temperature: 0,
      top_p: 0.1,
-      max_tokens: maxTokens || 500
+      max_tokens: MAX_TOKENS_OUTPUT
    };
    try {
      const REQUEST_TOKENS = messages
        .map((msg) => tokenCount(msg.content) + 4)
        .reduce((a, b) => a + b, 0);

-      if (REQUEST_TOKENS > DEFAULT_MODEL_TOKEN_LIMIT - maxTokens) {
+      if (REQUEST_TOKENS > MAX_TOKENS_INPUT - MAX_TOKENS_OUTPUT) {
        throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
      }

@@ -100,16 +105,6 @@ class OpenAi {
  };
 }

-export const getOpenCommitLatestVersion = async (): Promise<
-  string | undefined
-> => {
-  try {
-    const { stdout } = await execa('npm', ['view', 'opencommit', 'version']);
-    return stdout;
-  } catch (_) {
-    outro('Error while getting the latest version of opencommit');
-    return undefined;
-  }
-};
+

 export const api = new OpenAi();
--- a/src/generateCommitMessageFromGitDiff.ts
+++ b/src/generateCommitMessageFromGitDiff.ts
@@ -3,18 +3,21 @@ import {
  ChatCompletionRequestMessageRoleEnum
 } from 'openai';

-import { api } from './api';
-import { DEFAULT_MODEL_TOKEN_LIMIT, getConfig } from './commands/config';
+import { DEFAULT_TOKEN_LIMITS, getConfig } from './commands/config';
 import { getMainCommitPrompt } from './prompts';
 import { mergeDiffs } from './utils/mergeDiffs';
 import { tokenCount } from './utils/tokenCount';
+import { getEngine } from './utils/engine';

 const config = getConfig();
+const MAX_TOKENS_INPUT = config?.OCO_TOKENS_MAX_INPUT || DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_INPUT;
+const MAX_TOKENS_OUTPUT = config?.OCO_TOKENS_MAX_OUTPUT || DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_OUTPUT;

 const generateCommitMessageChatCompletionPrompt = async (
-  diff: string
+  diff: string,
+  fullGitMojiSpec: boolean
 ): Promise<Array<ChatCompletionRequestMessage>> => {
-  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt();
+  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);

  const chatContextAsCompletionRequest = [...INIT_MESSAGES_PROMPT];

@@ -29,31 +32,34 @@ const generateCommitMessageChatCompletionPrompt = async (
 export enum GenerateCommitMessageErrorEnum {
  tooMuchTokens = 'TOO_MUCH_TOKENS',
  internalError = 'INTERNAL_ERROR',
-  emptyMessage = 'EMPTY_MESSAGE'
+  emptyMessage = 'EMPTY_MESSAGE',
+  outputTokensTooHigh = `Token limit exceeded, OCO_TOKENS_MAX_OUTPUT must not be much higher than the default ${DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_OUTPUT} tokens.`
 }

 const ADJUSTMENT_FACTOR = 20;

 export const generateCommitMessageByDiff = async (
-  diff: string
+  diff: string,
+  fullGitMojiSpec: boolean
 ): Promise<string> => {
  try {
-    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt();
+    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);

    const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
      (msg) => tokenCount(msg.content) + 4
    ).reduce((a, b) => a + b, 0);

    const MAX_REQUEST_TOKENS =
-      DEFAULT_MODEL_TOKEN_LIMIT -
+      MAX_TOKENS_INPUT -
      ADJUSTMENT_FACTOR -
      INIT_MESSAGES_PROMPT_LENGTH -
-      config?.OCO_OPENAI_MAX_TOKENS;
+      MAX_TOKENS_OUTPUT;

    if (tokenCount(diff) >= MAX_REQUEST_TOKENS) {
      const commitMessagePromises = await getCommitMsgsPromisesFromFileDiffs(
        diff,
-        MAX_REQUEST_TOKENS
+        MAX_REQUEST_TOKENS,
+        fullGitMojiSpec
      );

      const commitMessages = [];
@@ -65,9 +71,10 @@ export const generateCommitMessageByDiff = async (
      return commitMessages.join('\n\n');
    }

-    const messages = await generateCommitMessageChatCompletionPrompt(diff);
+    const messages = await generateCommitMessageChatCompletionPrompt(diff, fullGitMojiSpec);

-    const commitMessage = await api.generateCommitMessage(messages);
+    const engine = getEngine()
+    const commitMessage = await engine.generateCommitMessage(messages);

    if (!commitMessage)
      throw new Error(GenerateCommitMessageErrorEnum.emptyMessage);
@@ -81,7 +88,8 @@ export const generateCommitMessageByDiff = async (
 function getMessagesPromisesByChangesInFile(
  fileDiff: string,
  separator: string,
-  maxChangeLength: number
+  maxChangeLength: number,
+  fullGitMojiSpec: boolean
 ) {
  const hunkHeaderSeparator = '@@ ';
  const [fileHeader, ...fileDiffByLines] = fileDiff.split(hunkHeaderSeparator);
@@ -104,13 +112,15 @@ function getMessagesPromisesByChangesInFile(
    }
  }

+  const engine = getEngine()
  const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map(
    async (lineDiff) => {
      const messages = await generateCommitMessageChatCompletionPrompt(
-        separator + lineDiff
+        separator + lineDiff,
+        fullGitMojiSpec
      );

-      return api.generateCommitMessage(messages);
+      return engine.generateCommitMessage(messages);
    }
  );

@@ -122,6 +132,10 @@ function splitDiff(diff: string, maxChangeLength: number) {
  const splitDiffs = [];
  let currentDiff = '';

+  if (maxChangeLength <= 0) {
+    throw new Error(GenerateCommitMessageErrorEnum.outputTokensTooHigh);
+  }
+
  for (let line of lines) {
    // If a single line exceeds maxChangeLength, split it into multiple lines
    while (tokenCount(line) > maxChangeLength) {
@@ -151,7 +165,8 @@ function splitDiff(diff: string, maxChangeLength: number) {

 export const getCommitMsgsPromisesFromFileDiffs = async (
  diff: string,
-  maxDiffLength: number
+  maxDiffLength: number,
+  fullGitMojiSpec: boolean
 ) => {
  const separator = 'diff --git ';

@@ -168,16 +183,19 @@ export const getCommitMsgsPromisesFromFileDiffs = async (
      const messagesPromises = getMessagesPromisesByChangesInFile(
        fileDiff,
        separator,
-        maxDiffLength
+        maxDiffLength,
+        fullGitMojiSpec
      );

      commitMessagePromises.push(...messagesPromises);
    } else {
      const messages = await generateCommitMessageChatCompletionPrompt(
-        separator + fileDiff
+        separator + fileDiff,
+        fullGitMojiSpec
      );

-      commitMessagePromises.push(api.generateCommitMessage(messages));
+      const engine = getEngine()
+      commitMessagePromises.push(engine.generateCommitMessage(messages));
    }
  }

--- a/src/modules/commitlint/config.ts
+++ b/src/modules/commitlint/config.ts
@@ -1,6 +1,5 @@
 import { spinner } from '@clack/prompts';

-import { api } from '../../api';
 import { getConfig } from '../../commands/config';
 import { i18n, I18nLocals } from '../../i18n';
 import { COMMITLINT_LLM_CONFIG_PATH } from './constants';
@@ -9,6 +8,7 @@ import { commitlintPrompts, inferPromptsFromCommitlintConfig } from './prompts';
 import { getCommitLintPWDConfig } from './pwd-commitlint';
 import { CommitlintLLMConfig } from './types';
 import * as utils from './utils';
+import { getEngine } from '../../utils/engine';

 const config = getConfig();
 const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
@@ -55,11 +55,16 @@ export const configureCommitlintIntegration = async (force = false) => {
  //   consistencyPrompts.map((p) => p.content)
  // );

+  const engine = getEngine()
  let consistency =
-    (await api.generateCommitMessage(consistencyPrompts)) || '{}';
+    (await engine.generateCommitMessage(consistencyPrompts)) || '{}';

  // Cleanup the consistency answer. Sometimes 'gpt-3.5-turbo' sends rule's back.
  prompts.forEach((prompt) => (consistency = consistency.replace(prompt, '')));
+
+  // sometimes consistency is preceded by explanatory text like "Here is your JSON:"
+  consistency = utils.getJSONBlock(consistency);
+  
  // ... remaining might be extra set of "\n"
  consistency = utils.removeDoubleNewlines(consistency);

--- a/src/modules/commitlint/pwd-commitlint.ts
+++ b/src/modules/commitlint/pwd-commitlint.ts
@@ -1,7 +1,7 @@
 import path from 'path';

 const nodeModulesPath = path.join(
-  process.env.PWD as string,
+  process.env.PWD || process.cwd(),
  'node_modules',
  '@commitlint',
  'load'
--- a/src/modules/commitlint/utils.ts
+++ b/src/modules/commitlint/utils.ts
@@ -16,6 +16,16 @@ export const removeDoubleNewlines = (input: string): string => {
  return input;
 };

+export const getJSONBlock = (input: string): string => {
+  const jsonIndex = input.search('```json');
+  if(jsonIndex > -1) {
+    input = input.slice(jsonIndex + 8);
+    const endJsonIndex = consistency.search('```');
+    input = input.slice(0, endJsonIndex); 
+  }
+  return input;
+};
+  
 export const commitlintLLMConfigExists = async (): Promise<boolean> => {
  let exists;
  try {
@@ -44,4 +54,4 @@ export const getCommitlintLLMConfig =
      content.toString()
    ) as CommitlintLLMConfig;
    return commitLintLLMConfig;
-  };
+};
--- a/src/prompts.ts
+++ b/src/prompts.ts
@@ -11,6 +11,7 @@ import { configureCommitlintIntegration } from './modules/commitlint/config';
 import { commitlintPrompts } from './modules/commitlint/prompts';
 import { ConsistencyPrompt } from './modules/commitlint/types';
 import * as utils from './modules/commitlint/utils';
+import { removeConventionalCommitWord } from './utils/removeConventionalCommitWord';

 const config = getConfig();
 const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
@@ -18,14 +19,97 @@ const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
 export const IDENTITY =
  'You are to act as the author of a commit message in git.';

-const INIT_MAIN_PROMPT = (language: string): ChatCompletionRequestMessage => ({
+const INIT_MAIN_PROMPT = (
+  language: string,
+  fullGitMojiSpec: boolean
+): ChatCompletionRequestMessage => ({
  role: ChatCompletionRequestMessageRoleEnum.System,
-  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the conventional commit convention and explain WHAT were the changes and mainly WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.
-    ${
-      config?.OCO_EMOJI
-        ? 'Use GitMoji convention to preface the commit.'
-        : 'Do not preface the commit with anything.'
-    }
+  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the ${
+    fullGitMojiSpec ? 'GitMoji specification' : 'conventional commit convention'
+  } and explain WHAT were the changes and mainly WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.
+  ${
+    config?.OCO_EMOJI
+      ? 'Use GitMoji convention to preface the commit. Here are some help to choose the right emoji (emoji, description): ' +
+        '🐛, Fix a bug; ' +
+        '✨, Introduce new features; ' +
+        '📝, Add or update documentation; ' +
+        '🚀, Deploy stuff; ' +
+        '✅, Add, update, or pass tests; ' +
+        '♻️, Refactor code; ' +
+        '⬆️, Upgrade dependencies; ' +
+        '🔧, Add or update configuration files; ' +
+        '🌐, Internationalization and localization; ' +
+        '💡, Add or update comments in source code; ' +
+        `${
+          fullGitMojiSpec
+            ? '🎨, Improve structure / format of the code; ' +
+              '⚡️, Improve performance; ' +
+              '🔥, Remove code or files; ' +
+              '🚑️, Critical hotfix; ' +
+              '💄, Add or update the UI and style files; ' +
+              '🎉, Begin a project; ' +
+              '🔒️, Fix security issues; ' +
+              '🔐, Add or update secrets; ' +
+              '🔖, Release / Version tags; ' +
+              '🚨, Fix compiler / linter warnings; ' +
+              '🚧, Work in progress; ' +
+              '💚, Fix CI Build; ' +
+              '⬇️, Downgrade dependencies; ' +
+              '📌, Pin dependencies to specific versions; ' +
+              '👷, Add or update CI build system; ' +
+              '📈, Add or update analytics or track code; ' +
+              '➕, Add a dependency; ' +
+              '➖, Remove a dependency; ' +
+              '🔨, Add or update development scripts; ' +
+              '✏️, Fix typos; ' +
+              '💩, Write bad code that needs to be improved; ' +
+              '⏪️, Revert changes; ' +
+              '🔀, Merge branches; ' +
+              '📦️, Add or update compiled files or packages; ' +
+              '👽️, Update code due to external API changes; ' +
+              '🚚, Move or rename resources (e.g.: files, paths, routes); ' +
+              '📄, Add or update license; ' +
+              '💥, Introduce breaking changes; ' +
+              '🍱, Add or update assets; ' +
+              '♿️, Improve accessibility; ' +
+              '🍻, Write code drunkenly; ' +
+              '💬, Add or update text and literals; ' +
+              '🗃️, Perform database related changes; ' +
+              '🔊, Add or update logs; ' +
+              '🔇, Remove logs; ' +
+              '👥, Add or update contributor(s); ' +
+              '🚸, Improve user experience / usability; ' +
+              '🏗️, Make architectural changes; ' +
+              '📱, Work on responsive design; ' +
+              '🤡, Mock things; ' +
+              '🥚, Add or update an easter egg; ' +
+              '🙈, Add or update a .gitignore file; ' +
+              '📸, Add or update snapshots; ' +
+              '⚗️, Perform experiments; ' +
+              '🔍️, Improve SEO; ' +
+              '🏷️, Add or update types; ' +
+              '🌱, Add or update seed files; ' +
+              '🚩, Add, update, or remove feature flags; ' +
+              '🥅, Catch errors; ' +
+              '💫, Add or update animations and transitions; ' +
+              '🗑️, Deprecate code that needs to be cleaned up; ' +
+              '🛂, Work on code related to authorization, roles and permissions; ' +
+              '🩹, Simple fix for a non-critical issue; ' +
+              '🧐, Data exploration/inspection; ' +
+              '⚰️, Remove dead code; ' +
+              '🧪, Add a failing test; ' +
+              '👔, Add or update business logic; ' +
+              '🩺, Add or update healthcheck; ' +
+              '🧱, Infrastructure related changes; ' +
+              '🧑‍💻, Improve developer experience; ' +
+              '💸, Add sponsorships or money related infrastructure; ' +
+              '🧵, Add or update code related to multithreading or concurrency; ' +
+              '🦺, Add or update code related to validation.'
+            : ''
+        }`
+      : 'Do not preface the commit with anything. Conventional commit keywords:' +
+        'fix, feat, build, chore, ci, docs, style, refactor, perf, test.'
+  }  
    ${
      config?.OCO_DESCRIPTION
        ? 'Add a short description of WHY the changes are done after the commit message. Don\'t start it with "This commit", just describe the changes.'
@@ -66,14 +150,22 @@ const INIT_CONSISTENCY_PROMPT = (
  translation: ConsistencyPrompt
 ): ChatCompletionRequestMessage => ({
  role: ChatCompletionRequestMessageRoleEnum.Assistant,
-  content: `${config?.OCO_EMOJI ? '🐛 ' : ''}${translation.commitFix}
-${config?.OCO_EMOJI ? '✨ ' : ''}${translation.commitFeat}
+  content: `${
+    config?.OCO_EMOJI
+      ? `🐛 ${removeConventionalCommitWord(translation.commitFix)}`
+      : translation.commitFix
+  }
+${
+  config?.OCO_EMOJI
+    ? `✨ ${removeConventionalCommitWord(translation.commitFeat)}`
+    : translation.commitFeat
+}
 ${config?.OCO_DESCRIPTION ? translation.commitDescription : ''}`
 });

-export const getMainCommitPrompt = async (): Promise<
-  ChatCompletionRequestMessage[]
-> => {
+export const getMainCommitPrompt = async (
+  fullGitMojiSpec: boolean
+): Promise<ChatCompletionRequestMessage[]> => {
  switch (config?.OCO_PROMPT_MODULE) {
    case '@commitlint':
      if (!(await utils.commitlintLLMConfigExists())) {
@@ -102,7 +194,7 @@ export const getMainCommitPrompt = async (): Promise<
    default:
      // conventional-commit
      return [
-        INIT_MAIN_PROMPT(translation.localLanguage),
+        INIT_MAIN_PROMPT(translation.localLanguage, fullGitMojiSpec),
        INIT_DIFF_PROMPT,
        INIT_CONSISTENCY_PROMPT(translation)
      ];
--- a/src/utils/checkIsLatestVersion.ts
+++ b/src/utils/checkIsLatestVersion.ts
@@ -3,7 +3,7 @@ import chalk from 'chalk';
 import { outro } from '@clack/prompts';

 import currentPackage from '../../package.json';
-import { getOpenCommitLatestVersion } from '../api';
+import { getOpenCommitLatestVersion } from '../version';

 export const checkIsLatestVersion = async () => {
  const latestVersion = await getOpenCommitLatestVersion();
--- a/src/utils/engine.ts
+++ b/src/utils/engine.ts
@@ -0,0 +1,13 @@
+import { AiEngine } from '../engine/Engine';
+import { api } from '../engine/openAi';
+import { getConfig } from '../commands/config';
+import { ollamaAi } from '../engine/ollama';
+
+export function getEngine(): AiEngine {
+  const config = getConfig();
+  if (config?.OCO_AI_PROVIDER == 'ollama') {
+    return ollamaAi;
+  }
+  //open ai gpt by default
+  return api;
+}
--- a/src/utils/removeConventionalCommitWord.ts
+++ b/src/utils/removeConventionalCommitWord.ts
@@ -0,0 +1,3 @@
+export function removeConventionalCommitWord(message: string): string {
+  return message.replace(/^(fix|feat)\((.+?)\):/, '($2):');
+}
--- a/src/version.ts
+++ b/src/version.ts
@@ -0,0 +1,14 @@
+import { outro } from "@clack/prompts";
+import { execa } from "execa";
+
+export const getOpenCommitLatestVersion = async (): Promise<
+  string | undefined
+> => {
+  try {
+    const { stdout } = await execa('npm', ['view', 'opencommit', 'version']);
+    return stdout;
+  } catch (_) {
+    outro('Error while getting the latest version of opencommit');
+    return undefined;
+  }
+};
Author	SHA1	Message	Date
di-sukharev	eaf6600299	3.0.11	2024-03-03 20:02:21 +08:00
di-sukharev	401be04b4d	fix(githook.ts): update error message to include command example for better user guidance	2024-03-03 19:58:23 +08:00
di-sukharev	a9a2131ebf	build	2024-03-03 19:57:37 +08:00
Maxence d'Espeuilles	7dd8094760	🔧 refactor(commit.ts): remove messageTemplate from extraArgs to avoid duplication in commit message (#279 )	2024-03-03 19:56:53 +08:00
di-sukharev	a3d3363a01	build	2024-03-03 19:44:31 +08:00
di-sukharev	75d0f57f09	3.0.10	2024-03-03 19:44:30 +08:00
di-sukharev	8c92b92868	Merge branch 'dev'	2024-03-03 19:44:07 +08:00
di-sukharev	a33027b4db	🔀 refactor(commit.ts): rearrange function parameters for better readability 🎨 style(commit.ts): improve code formatting for generateCommitMessageByDiff function call	2024-03-03 19:43:40 +08:00
di-sukharev	c1797de3da	build	2024-03-03 19:43:15 +08:00
di-sukharev	3d49081f6d	build	2024-03-03 19:39:00 +08:00
di-sukharev	8c318d96f4	Merge branch 'dev' of github.com:di-sukharev/opencommit into dev	2024-03-03 19:37:21 +08:00
Malthe Poulsen	9b7337f67f	Support Gitmoji Format in Commit Messages (#249 ) * 📝 docs(prompts.ts): update prompt message to include information about GitMoji convention and descriptions of changes 📝 docs(prompts.ts): update prompt message to include information about GitMoji convention and descriptions of changes * 🎨 (prompts.ts): import `removeConventionalCommitWord` function to remove conventional commit word from commit prompts 🐛 (prompts.ts): remove conventional commit word from `commitFix` and `commitFeat` prompts to improve clarity 📝 (removeConventionalCommitWord.ts): add `removeConventionalCommitWord` function to remove conventional commit word from commit message * 📝 (package.json): update version from 3.0.3 to 3.0.0 to align with the latest release * 🔧 (cli.ts): add a new flag 'fgm' to the 'flags' object to support the '--fgm' flag in the CLI command 🔧 (commit.ts): pass the value of the 'fgm' flag to the 'commit' function to enable or disable full GitMoji specification ♻️ (commit.ts): refactor the 'commit' function to accept the 'fullGitMojiSpec' parameter and pass it to the 'commit' function recursively ♻️ (generateCommitMessageFromGitDiff.ts): refactor the 'generateCommitMessageByDiff' function to accept the 'fullGitMojiSpec' parameter and pass it to the 'generateCommitMessageChatCompletionPrompt' function ♻️ (generateCommitMessageFromGitDiff.ts): refactor the 'generateCommitMessageChatCompletionPrompt' function to accept the 'fullGitMojiSpec' parameter and pass it to the 'getMainCommitPrompt' function ♻️ (generateCommitMessageFromGitDiff.ts): refactor the 'getCommitMsgsPromisesFromFileDiffs' function to accept the 'fullGitMojiSpec' parameter and pass it to the 'getMessagesPromisesByChangesInFile' function ♻️ (generateCommitMessageFromGitDiff.ts): refactor the 'getMessagesPromisesByChangesInFile' function to accept the 'fullGitMojiSpec' parameter and pass it to the 'generateCommitMessageChatCompletionPrompt' function ♻️ (prompts.ts): refactor the 'getMainCommitPrompt' function to accept the 'fullGitMojiSpec' parameter and pass it to the 'INIT_MAIN_PROMPT' function * 📝 (README.md): add documentation for the `--fgm` flag in the `oco` command to enable the use of the full GitMoji specification * 📝 (README.md): update flag description for using full GitMoji specification 📝 (README.md): add link to the GitMoji specification for reference * 🔧 (README.md): fix a typo in the description of the `Use Full GitMoji Specification` flag 🔧 (api.ts): update the default value of the `apiKey` variable to a placeholder value for testing purposes * Revert "🔧 (README.md): fix a typo in the description of the `Use Full GitMoji Specification` flag" This reverts commit `230a4aa449`. * 🔧 (README.md): fix a typo in the description of the `Use Full GitMoji Specification` flag * 📝 (prompts.ts): update INIT_MAIN_PROMPT content to include information about the fullGitMojiSpec flag and provide instructions on how to choose the right emoji for the commit message --------- Co-authored-by: GPT10 <57486732+di-sukharev@users.noreply.github.com>	2024-03-03 19:36:55 +08:00
di-sukharev	0b5adf104a	build	2024-03-03 19:36:23 +08:00
Jack Lukic	ec699c48bf	Bug (commitling) Parse JSON blocks from return response (#297 )	2024-03-03 19:23:44 +08:00
mattsalt123	c9b45492a5	feat: Add Input Token Limit Config Option (#281 )	2024-02-29 23:06:23 +08:00
di-sukharev	b0b90679a4	build	2024-02-28 19:29:20 +08:00
di-sukharev	02cef105a6	3.0.9	2024-02-28 19:29:17 +08:00
di-sukharev	407ca4b244	build	2024-02-28 19:19:42 +08:00
di-sukharev	62e44e5e35	3.0.8	2024-02-28 19:19:41 +08:00
di-sukharev	03fce6f5cf	build	2024-02-28 19:19:11 +08:00
di-sukharev	6155fca4b1	3.0.7	2024-02-28 19:19:09 +08:00
di-sukharev	22d4af48c7	build	2024-02-28 19:19:04 +08:00
di-sukharev	17d5a7143f	Merge branch 'dev'	2024-02-28 19:18:11 +08:00
Isaac Johnston	011db5ad5e	feat: add instructions and support for configuring GPT-4 Turbo (Preview) (#274 ) * docs(README.md): add instructions for configuring GPT-4 Turbo (Preview) feat(config.ts): include 'gpt-4-1106-preview' in the list of supported models * fix(config.ts): update error message to include 'gpt-4-1106-preview' as a supported model	2024-02-28 19:17:10 +08:00
di-sukharev	89682f0397	remove stale issue action	2024-02-28 14:01:07 +08:00
di-sukharev	9ed9174b6f	build	2024-02-27 22:17:08 +08:00
di-sukharev	53ae8926fa	3.0.6	2024-02-27 22:17:06 +08:00
di-sukharev	6c743ba230	chore(README.md): update link to GitHub 2023 hackathon in README The link to the GitHub 2023 hackathon in the README has been updated to point to the correct URL. This ensures that users can easily access the relevant information about the hackathon.	2024-02-27 22:16:23 +08:00
di-sukharev	9852c36a98	build	2024-02-27 22:07:18 +08:00
di-sukharev	5f85cafc7e	3.0.5	2024-02-27 22:07:16 +08:00
di-sukharev	0591e6e81e	docs(README.md): add alternative ways to run OpenCommit via npx and bunx The README.md file has been updated to include alternative ways to run OpenCommit via the `npx opencommit` and `bunx opencommit` commands. This provides users with more options to execute the tool without the need for a global installation.	2024-02-27 22:06:08 +08:00
di-sukharev	a296892aaf	build	2024-02-27 22:04:39 +08:00
di-sukharev	45958284c9	Merge branch 'master' into dev	2024-02-27 22:04:13 +08:00
Jaroslaw Weber	1d6980faf3	add ollama support (#269 ) * add ollama support --------- Co-authored-by: di-sukharev <dim.sukharev@gmail.com> Co-authored-by: GPT10 <57486732+di-sukharev@users.noreply.github.com> Co-authored-by: Jaroslaw Weber <jaroslaw.weber@adriel.com>	2024-02-27 22:01:13 +08:00
di-sukharev	f793f01059	Merge branch 'master' of github.com:di-sukharev/opencommit	2023-11-27 12:14:13 +08:00
di-sukharev	7deffa8ee2	update twitter	2023-11-27 12:00:28 +08:00
GPT10	84dfc85328	Update README.md fix(README.md): GitHub hackathon link	2023-10-05 22:05:45 +08:00
di-sukharev	b79aef5fad	build	2023-09-18 14:23:43 +08:00
di-sukharev	57d9cc59b5	fix(config.ts): add default value for config parameter in OCO_OPENAI_API_KEY validator function The OCO_OPENAI_API_KEY validator function now accepts an optional config parameter with a default value of an empty object {}. This change ensures that the function can be called without providing the config parameter, improving flexibility and avoiding potential errors when the parameter is not provided.	2023-09-18 14:21:55 +08:00
di-sukharev	e599700d72	build	2023-09-09 15:52:29 +08:00
di-sukharev	2761403735	Merge remote-tracking branch 'origin/master' into dev	2023-09-09 15:52:13 +08:00
di-sukharev	e57033c4a1	chore(README.md): update information about default model and cost The default model used by OpenCommit is ChatGPT (3.5-turbo-16k) official model. It is mentioned that the cost should not exceed $0.10 per casual working day. Additionally, it is now mentioned that users have the option to switch to gpt-4, which is better but more expensive. This update provides users with more information about the available models and their associated costs.	2023-09-05 20:30:39 +08:00
di-sukharev	ca049e4b5d	chore(package.json): update deploy script to push tags before publishing to npm The deploy script in package.json has been updated to push tags before publishing to npm. This ensures that the latest version tag is pushed to the remote repository before publishing the package.	2023-09-05 13:57:20 +08:00
di-sukharev	2d48648f52	chore(package.json): update version to 3.0.3 The version in package.json has been updated from 3.0.2 to 3.0.3. This change is made to reflect the latest version of the project.	2023-09-05 13:51:21 +08:00
di-sukharev	40297e0c6a	chore(package.json): update version to 3.0.2 The version in package.json has been updated from 3.0.1 to 3.0.2. This change is made to reflect the latest version of the project.	2023-09-05 13:49:17 +08:00
di-sukharev	75f0cd47b8	chore(package.json): update version to 3.0.1 The version in package.json has been updated from 3.0.0 to 3.0.1. This change is made to reflect the new version of the project.	2023-09-05 13:48:09 +08:00
Sukharev	c76313737d	#247 : fix (#248 )	2023-09-05 13:45:34 +08:00
di-sukharev	a2b1890e7e	build	2023-09-05 13:42:30 +08:00
di-sukharev	df705b97b7	Merge remote-tracking branch 'origin/master' into dev	2023-09-05 13:42:22 +08:00
di-sukharev	df280b7db7	fix(commitlint): use process.cwd() as fallback for process.env.PWD to ensure compatibility across platforms The commitlint module now uses process.cwd() as a fallback when process.env.PWD is not available. This ensures compatibility across different platforms and environments when determining the path to the node_modules directory.	2023-09-05 13:39:49 +08:00
Sukharev	67dff60a7d	chore(prompts.ts): update INIT_MAIN_PROMPT content to provide clearer instructions and improve readability (#245 )	2023-09-03 15:39:52 +08:00
di-sukharev	ac8c87be9e	docs(README.md): add note about MacOS potentially requiring 'sudo' when installing package globally The README.md file now includes a note that MacOS may prompt the user to run the 'npm install -g opencommit' command with 'sudo' when installing the package globally. This note is added to provide clarity and help users who encounter this situation.	2023-09-03 15:22:47 +08:00
di-sukharev	a9050fda39	build	2023-09-03 15:17:12 +08:00
Sukharev	b98b892ba1	v3.0.0 (#243 ) * update major version --------- Co-authored-by: E Einowski <5124085+EwiththeBowtie@users.noreply.github.com> Co-authored-by: Max Zavodniuk <lovemaxonly@gmail.com> Co-authored-by: Malthe Poulsen <30603252+malpou@users.noreply.github.com> Co-authored-by: Sébastien Fichot <fichot.sebastien@gmail.com>	2023-09-03 15:16:02 +08:00