From da21673b33fbb2a799f4e1ffd56a01f2e59455c0 Mon Sep 17 00:00:00 2001 From: "vanta.nox" <200978133+Ap-0007@users.noreply.github.com> Date: Thu, 16 Jul 2026 13:03:14 +0530 Subject: [PATCH 1/3] docs: add custom provider instructions to README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 44c8b13..30e38ba 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,8 @@ Note: The non-interactive flags `--yes`, `-y`, and `--auto` expect staged change Run `commit-echo init` to configure your provider and model. Configuration is stored in `~/.config/commit-echo/config.json`. +To add a custom provider, create a file in the `src/providers` directory (e.g., `src/providers/my-provider.ts`) and add it to the `BUILTIN_PROVIDERS` list. Then, wire it into the `createProvider()` function. You can also use the `__custom__` provider key and set the `CUSTOM_API_KEY` environment variable to point to your custom endpoint. + If you want `git commit` to prefill the first suggestion automatically, run `commit-echo init --install-hook` from inside a Git repository. This installs both a `prepare-commit-msg` hook (prefills the first suggestion) and a `post-commit` hook (logs the committed message for style learning). The hooks skip merge commits, cherry-picks, amend flows, and any commit where a message was already supplied. ### Options From 5d941f920a9c80c23f08afee33b3939a3c8daefa Mon Sep 17 00:00:00 2001 From: Ap-0007 Date: Tue, 4 Aug 2026 12:07:53 +0530 Subject: [PATCH 2/3] fix: clarify custom provider setup --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 30e38ba..5152385 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ Note: The non-interactive flags `--yes`, `-y`, and `--auto` expect staged change Run `commit-echo init` to configure your provider and model. Configuration is stored in `~/.config/commit-echo/config.json`. -To add a custom provider, create a file in the `src/providers` directory (e.g., `src/providers/my-provider.ts`) and add it to the `BUILTIN_PROVIDERS` list. Then, wire it into the `createProvider()` function. You can also use the `__custom__` provider key and set the `CUSTOM_API_KEY` environment variable to point to your custom endpoint. +To add a custom provider, create a file in the `src/providers` directory (e.g., `src/providers/my-provider.ts`) and add it to the `BUILTIN_PROVIDERS` list. Then, wire it into the `createProvider()` function. You can also use the `__custom__` provider key, configure the endpoint base URL with `commit-echo init` (or `COMMIT_ECHO_BASE_URL`), and set `CUSTOM_API_KEY` to the endpoint's API key. If you want `git commit` to prefill the first suggestion automatically, run `commit-echo init --install-hook` from inside a Git repository. This installs both a `prepare-commit-msg` hook (prefills the first suggestion) and a `post-commit` hook (logs the committed message for style learning). The hooks skip merge commits, cherry-picks, amend flows, and any commit where a message was already supplied. From bec588c9e4d752a7aa65a19438487dc5648e8626 Mon Sep 17 00:00:00 2001 From: 404-Page-Found <139850808+404-Page-Found@users.noreply.github.com> Date: Tue, 4 Aug 2026 18:19:06 +1000 Subject: [PATCH 3/3] Update README.md Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5152385..4f018b5 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ Note: The non-interactive flags `--yes`, `-y`, and `--auto` expect staged change Run `commit-echo init` to configure your provider and model. Configuration is stored in `~/.config/commit-echo/config.json`. -To add a custom provider, create a file in the `src/providers` directory (e.g., `src/providers/my-provider.ts`) and add it to the `BUILTIN_PROVIDERS` list. Then, wire it into the `createProvider()` function. You can also use the `__custom__` provider key, configure the endpoint base URL with `commit-echo init` (or `COMMIT_ECHO_BASE_URL`), and set `CUSTOM_API_KEY` to the endpoint's API key. +To add a custom provider, create a file in the `src/providers` directory (e.g., `src/providers/my-provider.ts`) and add it to the `BUILTIN_PROVIDERS` list. Then, wire it into the `createProvider()` function. You can also use the `__custom__` provider key for an OpenAI-compatible endpoint, configure the base URL with `commit-echo init` (or `COMMIT_ECHO_BASE_URL`), and set `CUSTOM_API_KEY` to the endpoint's API key. If you want `git commit` to prefill the first suggestion automatically, run `commit-echo init --install-hook` from inside a Git repository. This installs both a `prepare-commit-msg` hook (prefills the first suggestion) and a `post-commit` hook (logs the committed message for style learning). The hooks skip merge commits, cherry-picks, amend flows, and any commit where a message was already supplied.