git-cai-cli 0.7.4__tar.gz → 0.8.0__tar.gz

{git_cai_cli-0.7.4 → git_cai_cli-0.8.0}/.linters/.pylintrc

@@ -66,7 +66,7 @@ check-protected-access-in-special-methods=no
                                            # Don’t warn about protected attr access in dunder methods
 
 [DESIGN]
-max-args=10                                # Max arguments per function
+max-args=15                                # Max arguments per function
 max-attributes=7                           # Max attributes per class
 max-branches=20                            # Max branches per function
 max-locals=30                              # Max locals per function
@@ -77,7 +77,7 @@ min-public-methods=1                       # Min public methods per class
 max-nested-blocks=15                       # Max nesting depth
 max-bool-expr=15                           # Max boolean subexpressions in a condition
 max-parents=7                              # Max base classes per class
-max-positional-arguments=10                # Max positional arguments per function
+max-positional-arguments=15                # Max positional arguments per function
 
 [EXCEPTIONS]
 overgeneral-exceptions=builtins.BaseException,builtins.Exception
@@ -94,6 +94,7 @@ disable=logging-too-many-args,
         import-error,
         wrong-import-order,
         import-outside-toplevel,
+        duplicate-code,
                                            # Disable noisy/meta warnings
 
 

git_cai_cli-0.8.0/.markdownlintignore

@@ -0,0 +1,2 @@
+commit_prompt.md
+squash_prompt.md

{git_cai_cli-0.7.4 → git_cai_cli-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-cai-cli
-Version: 0.7.4
+Version: 0.8.0
 Summary: Use LLM to create git commit messages
 Author-email: Thorsten Foltz <thorsten.foltz@live.com>
 License-Expression: MIT
@@ -48,6 +48,7 @@ Currently supported providers:
 - xAI
 - Mistral
 - DeepSeek
+- Ollama (local)
 
 ---
 
@@ -55,7 +56,9 @@ Currently supported providers:
 
 - Python 3.10 or higher
 - [pipx](https://pypi.org/project/pipx/)
-- An API key for at least one of the following providers:
+- Either:
+  - Ollama installed and running locally, or
+  - An API key for at least one of the following providers:
   - OpenAI
   - Gemini (free tier available)
   - Anthropic
@@ -72,7 +75,7 @@ Currently supported providers:
 - Generates meaningful, context-aware commit messages using an LLM
 - Seamless integration with Git
 - Supports multiple LLM providers and models
-- Global configuration with **per-repository overrides**
+- Global configuration with per-repository overrides
 - Repository-specific language, style, and model selection
 - Optional commit squashing with automatic summary generation
 
@@ -129,7 +132,7 @@ The syntax is identical to `.gitignore`.
 
 ## Configuration
 
-On first execution, cai automatically creates two configuration files:
+On first execution, cai automatically creates the base configuration in your home directory.
 
 - Global configuration:  
   ~/.config/cai/cai_config.yml
@@ -137,13 +140,40 @@ On first execution, cai automatically creates two configuration files:
 - API tokens:  
   ~/.config/cai/tokens.yml
 
+It also creates two Markdown prompt files:
+
+- Default commit prompt:  
+  ~/.config/cai/commit_prompt.md
+- Default squash prompt:  
+  ~/.config/cai/squash_prompt.md
+
 Don't be scared the first run will show an error. It only misses a token.
 Add your provider API keys to `tokens.yml`. Once configured, cai will reuse them automatically.
 Set your preferred LLM in `cai_config.yml` (Groq by default).
 
+If you want to use Ollama, set `default: ollama` and configure the `ollama:` block (model/temperature). Ollama is automatically started when used.
+
+### Custom prompts (Markdown)
+
+The generated commit message is guided by prompt files.
+
+- By default, `cai_config.yml` points to the auto-created prompt files in `~/.config/cai/`.
+- To use your own prompts in a repository, generate templates at the root of the repository:
+
+```sh
+git cai -p
+```
+
+This creates:
+
+- `commit_prompt.md`
+- `squash_prompt.md`
+
+Then set `prompt_file` and/or `squash_prompt_file` in your `cai_config.yml` (also repo) to point to those files.
+
 ### Repository-specific configuration
 
-Each repository can be configured **independently**.
+Each repository can be configured independently.
 
 If a `cai_config.yml` file exists in the root of a repository, cai will use it instead of the global configuration.  
 This allows different projects to use different providers, models, languages, and styles.
@@ -178,6 +208,8 @@ git cai -g
 - `style` – tone or style of the commit message
 - `emoji` – enable or disable emojis
 - `load_tokens_from` – path to the file where API tokens are stored
+- `prompt_file` - path to the file where the prompt for the commit is stored
+- `squash_prompt_file` - path to the file where the prompt for the squash is stored
 
 ---
 
@@ -189,8 +221,9 @@ In addition to `git cai`, the following options are available:
 - `-a`, `--all` – stage all tracked modified and deleted files
 - `-c`, `--crazy` – Trust the LLM and commit without checking
 - `-d`, `--debug` – enable debug logging
-- `-g`, `--generate-config` – generate the default `git_config.yml` in the current directory
-- `-l`, `--list` – list available languages and styles
+- `-g`, `--generate-config` – generate the default `cai_config.yml` in the current directory
+- `-l`, `--list` – list available languages, styles, and supported editors
+- `-p`, `--generate-prompts` – generate default `commit_prompt.md` and `squash_prompt.md` in the current directory (for customization)
 - `-s`, `--squash` – squash commits on the current branch and summarize them
 - `-u`, `--update` – check for updates
 - `-v`, `--version` – show the installed version

{git_cai_cli-0.7.4 → git_cai_cli-0.8.0}/README.md

@@ -19,6 +19,7 @@ Currently supported providers:
 - xAI
 - Mistral
 - DeepSeek
+- Ollama (local)
 
 ---
 
@@ -26,7 +27,9 @@ Currently supported providers:
 
 - Python 3.10 or higher
 - [pipx](https://pypi.org/project/pipx/)
-- An API key for at least one of the following providers:
+- Either:
+  - Ollama installed and running locally, or
+  - An API key for at least one of the following providers:
   - OpenAI
   - Gemini (free tier available)
   - Anthropic
@@ -43,7 +46,7 @@ Currently supported providers:
 - Generates meaningful, context-aware commit messages using an LLM
 - Seamless integration with Git
 - Supports multiple LLM providers and models
-- Global configuration with **per-repository overrides**
+- Global configuration with per-repository overrides
 - Repository-specific language, style, and model selection
 - Optional commit squashing with automatic summary generation
 
@@ -100,7 +103,7 @@ The syntax is identical to `.gitignore`.
 
 ## Configuration
 
-On first execution, cai automatically creates two configuration files:
+On first execution, cai automatically creates the base configuration in your home directory.
 
 - Global configuration:  
   ~/.config/cai/cai_config.yml
@@ -108,13 +111,40 @@ On first execution, cai automatically creates two configuration files:
 - API tokens:  
   ~/.config/cai/tokens.yml
 
+It also creates two Markdown prompt files:
+
+- Default commit prompt:  
+  ~/.config/cai/commit_prompt.md
+- Default squash prompt:  
+  ~/.config/cai/squash_prompt.md
+
 Don't be scared the first run will show an error. It only misses a token.
 Add your provider API keys to `tokens.yml`. Once configured, cai will reuse them automatically.
 Set your preferred LLM in `cai_config.yml` (Groq by default).
 
+If you want to use Ollama, set `default: ollama` and configure the `ollama:` block (model/temperature). Ollama is automatically started when used.
+
+### Custom prompts (Markdown)
+
+The generated commit message is guided by prompt files.
+
+- By default, `cai_config.yml` points to the auto-created prompt files in `~/.config/cai/`.
+- To use your own prompts in a repository, generate templates at the root of the repository:
+
+```sh
+git cai -p
+```
+
+This creates:
+
+- `commit_prompt.md`
+- `squash_prompt.md`
+
+Then set `prompt_file` and/or `squash_prompt_file` in your `cai_config.yml` (also repo) to point to those files.
+
 ### Repository-specific configuration
 
-Each repository can be configured **independently**.
+Each repository can be configured independently.
 
 If a `cai_config.yml` file exists in the root of a repository, cai will use it instead of the global configuration.  
 This allows different projects to use different providers, models, languages, and styles.
@@ -149,6 +179,8 @@ git cai -g
 - `style` – tone or style of the commit message
 - `emoji` – enable or disable emojis
 - `load_tokens_from` – path to the file where API tokens are stored
+- `prompt_file` - path to the file where the prompt for the commit is stored
+- `squash_prompt_file` - path to the file where the prompt for the squash is stored
 
 ---
 
@@ -160,8 +192,9 @@ In addition to `git cai`, the following options are available:
 - `-a`, `--all` – stage all tracked modified and deleted files
 - `-c`, `--crazy` – Trust the LLM and commit without checking
 - `-d`, `--debug` – enable debug logging
-- `-g`, `--generate-config` – generate the default `git_config.yml` in the current directory
-- `-l`, `--list` – list available languages and styles
+- `-g`, `--generate-config` – generate the default `cai_config.yml` in the current directory
+- `-l`, `--list` – list available languages, styles, and supported editors
+- `-p`, `--generate-prompts` – generate default `commit_prompt.md` and `squash_prompt.md` in the current directory (for customization)
 - `-s`, `--squash` – squash commits on the current branch and summarize them
 - `-u`, `--update` – check for updates
 - `-v`, `--version` – show the installed version

git_cai_cli-0.8.0/docs/git-cai.txt

@@ -0,0 +1,198 @@
+git-cai(1)
+==========
+Thorsten Foltz
+February 2026
+
+NAME
+----
+git-cai - AI-powered commit message generator
+
+SYNOPSIS
+--------
+[verse]
+`git cai` [-a | --all] [-c | --crazy] [-d | --debug] [-g | --generate-config]
+        [-l [editor|language|style] | --list [editor|language|style]]
+        [-p | --generate-prompts] [-s | --squash] [-u | --update] [-v | --version]
+
+
+DESCRIPTION
+-----------
+git-cai is a Git extension that generates commit
+messages from staged changes using AI.
+
+The command is invoked as `git cai` and integrates into Git using the
+standard Git extension mechanism.
+
+git-cai behaves like `git commit`, but with the commit message pre-filled:
+
+- It reads the staged diff (`git diff --cached`).
+- It sends the diff to the configured LLM provider/model.
+- It opens your configured Git editor so you can review/edit before committing.
+
+SETUP
+-----
+First run / configuration:
+
+- Run `git cai` once. If no config exists yet, git-cai creates:
+  `~/.config/cai/cai_config.yml` (global config) and ensures default prompt files exist:
+  `~/.config/cai/commit_prompt.md` and `~/.config/cai/squash_prompt.md`.
+- Add at least one API key to `~/.config/cai/tokens.yml` (created as a template if missing).
+  The YAML keys are provider names (for example: `openai`, `anthropic`, `gemini`,
+  `groq`, `xai`, `mistral`, `deepseek`).
+  If you use `ollama` as provider, no token is required.
+- In `~/.config/cai/cai_config.yml`, set `default:` to the provider you want and
+  adjust the provider block (model/temperature) as needed.
+
+Repository-specific setup (optional):
+
+- Put a `cai_config.yml` (or `cai_config.yaml`) into the repository root.
+  This repository config is authoritative and is not merged with the home config.
+- Generate a starting point with `git cai -g` (creates `cai_config.yml` in the
+  current directory).
+
+Custom prompts (optional):
+
+- Generate prompt files in the current directory with `git cai -p`.
+- Point `prompt_file` / `squash_prompt_file` in `cai_config.yml` to your custom files.
+
+OPTIONS
+-------
+-h, --help::
+Show this help message.
+
+-a, --all::
+Stage all modified and deleted files that are already tracked by Git
+before generating the commit message.
+
+-c, --crazy::
+Automatically commit changes using an LLM-generated message without user confirmation.
+
+-d, --debug::
+Enable debug logging.
+
+-g, --generate-config::
+Generate default cai_config.yml in the current directory.
+
+-l, --list::
+List information. Provide one of `editor`, `language`, or `style` as the next argument.
+
+-p, --generate-prompts::
+Generate default commit_prompt.md and squash_prompt.md in the current directory.
+Use these as a starting point for custom prompts.
+
+-s, --squash::
+Squash commits on the current branch and summarize them.
+
+-u, --update::
+Check for updates.
+
+-v, --version::
+Show the installed version.
+
+LIST TYPES
+----------
+The argument to `--list` must be one of the following:
+
+editor::
+List supported and tested editors as default git editor. Most likely more editors will work.
+
+language::
+List supported languages.
+
+style::
+Show available commit message styles.
+
+CONFIGURATION
+-------------
+Configuration precedence:
+
+1. Repository config: `<repo-root>/cai_config.yml` or `<repo-root>/cai_config.yaml`
+2. Home config: `~/.config/cai/cai_config.yml`
+3. Built-in defaults (written to the home config file on first run)
+
+Authentication tokens are loaded from:
+
+----
+$HOME/.config/cai/tokens.yml
+----
+
+Config is loaded by default from:
+
+----
+$HOME/.config/cai/cai_config.yml
+----
+
+cai_config.yml (or cai_config.yaml) can be loaded from the root of a repository.
+If present, it replaces the home config for that repository.
+
+Tokens can be loaded from everywhere defined within "load_tokens_from"
+in cai_config.yml
+
+FILES
+-----
+`~/.config/cai/cai_config.yml`::
+Global configuration (created automatically if missing).
+
+`~/.config/cai/tokens.yml`::
+Provider API keys (created as a template if missing).
+
+`~/.config/cai/commit_prompt.md` and `~/.config/cai/squash_prompt.md`::
+Default prompt files (created automatically if missing/empty). You can point
+`prompt_file` and `squash_prompt_file` to other locations.
+
+`<repo-root>/.caiignore`::
+Optional ignore file. Patterns are appended as exclusions when git-cai runs
+`git diff --cached`.
+
+EDITOR
+------
+git-cai uses the same editor resolution as Git (via `git var GIT_EDITOR` and the
+usual `GIT_EDITOR`/`VISUAL`/`EDITOR` environment variables).
+
+In the default commit-message flow, git-cai opens an editor with the generated
+message in a temporary file:
+
+- Save and exit to continue with the commit.
+- Close without saving to abort.
+
+If you use a GUI editor, the template starts with a line `# DELETE THIS LINE...`.
+Delete it to accept the commit.
+
+EXAMPLES
+--------
+Generate a commit message from staged changes:
+
+----
+git add -A
+git cai
+----
+
+Stage tracked changes (like `git commit -a`) and generate a message:
+
+----
+git cai -a
+----
+
+Commit immediately without opening the editor:
+
+----
+git cai -c
+----
+
+Squash all commits on the current branch into one (rewrites history):
+
+----
+git cai -s
+----
+
+Show supported styles/languages/editors:
+
+----
+git cai -l style
+git cai -l language
+git cai -l editor
+----
+
+SEE ALSO
+--------
+git(1)