@lenadweb/aicmt 0.1.1 → 0.1.3

package/README.md

@@ -5,6 +5,8 @@ AI-assisted git commits via OpenRouter. Designed for fast, consistent commit mes
 ## What it does
 
 - Generates 3 commit message options from the staged diff
+- Splits changes into multiple logical commits with `--split`
+- Adds custom prefixes to commit messages with `--prefix`
 - Supports global defaults with per-repo overrides
 - Can auto-stage and auto-commit with `-y`
 - Logs AI request/response with `--verbose` for troubleshooting
@@ -22,15 +24,17 @@ AI-assisted git commits via OpenRouter. Designed for fast, consistent commit mes
 - Node.js 16+
 - Git
 
-## Install (local dev)
+## Install
 
 ```
-npm install
-npm run build
-npm link
+npm install -g @lenadweb/aicmt
 ```
 
-After linking, the `aicmt` command is available globally.
+Or run without installing:
+
+```
+npx @lenadweb/aicmt
+```
 
 ## Global config
 
@@ -78,6 +82,97 @@ If there are unstaged changes, aicmt will ask to stage them. It always commits a
 - `--dry-run`: Show the chosen message without committing
 - `-v, --verbose`: Print AI request and response logs
 - `-y, --yes`: Skip prompts (stage all, pick first message, auto-confirm)
+- `-s, --split`: Split changes into multiple logical commits (file-level)
+- `--split-hunks`: Split changes at hunk level (experimental)
+- `--prefix <string>`: Add a prefix before the commit message (e.g., ticket number)
+
+## Split mode
+
+When you have multiple unrelated changes, use `--split` to automatically decompose them into separate commits:
+
+```
+aicmt commit --split
+```
+
+The AI analyzes your diff and groups files by logical changes:
+
+```
+Analyzing 5 changed files...
+
+Proposed 3 commits:
+
+  1. feat: add user authentication
+    - src/auth.ts
+    - src/middleware/auth.ts
+
+  2. fix: correct validation logic
+    - src/validators.ts
+
+  3. docs: update API documentation
+    - README.md
+    - docs/api.md
+
+Proceed with these 3 commits? (Y/n)
+```
+
+Split mode works with other flags:
+
+- `--split --dry-run`: Preview proposed commits without creating them
+- `--split -y`: Auto-confirm all commits
+- `--split -v`: Show AI request/response for debugging
+
+## Hunk-level split (experimental)
+
+For finer control, use `--split-hunks` to split changes within files:
+
+```
+aicmt commit --split-hunks
+```
+
+This mode analyzes individual hunks (contiguous blocks of changes) rather than whole files:
+
+```
+Analyzing 4 hunks across 2 files...
+(experimental hunk-level split mode)
+
+Proposed 2 commits:
+
+  1. fix: correct error handling in auth
+    - src/auth.ts:1
+    - src/auth.ts:2
+
+  2. feat: add logging middleware
+    - src/auth.ts:3
+    - src/middleware.ts:1
+
+Proceed with these 2 commits? (Y/n)
+```
+
+This is useful when a single file contains multiple unrelated changes. If something goes wrong, the tool will automatically rollback all commits.
+
+**Note:** This is experimental. Use `--dry-run` first to preview the proposed split.
+
+## Commit message prefix
+
+Add a prefix (like a ticket number) to all commit messages:
+
+```
+aicmt commit --prefix "DEV-95: "
+```
+
+The AI generates the commit message, then the prefix is added programmatically:
+
+```
+DEV-95: fix: update validation logic
+```
+
+This works with all modes:
+
+- `--prefix "JIRA-123: "`: Standard commit with prefix
+- `--prefix "TASK-456: " --split`: All split commits get the prefix
+- `--prefix "FIX-789: " -y`: Auto-commit with prefix
+
+The prefix is not sent to the AI, it's applied as post-processing to the generated message.
 
 ## Config format
 
@@ -112,6 +207,16 @@ Notes:
 - `OpenRouter error 400`: your output tokens are too high or diff is too large. Lower `maxTokens` or reduce the staged diff.
 - `Not a git repository`: run inside a git repo.
 
+## Local development
+
+```
+npm install
+npm run build
+npm link
+```
+
+After linking, the `aicmt` command is available globally.
+
 ## Development
 
 ```