summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-08-17 09:18:18 +0300
committerPaul Buetow <paul@buetow.org>2025-08-17 09:18:18 +0300
commita8db7af2a094a16393f0060e628310d4161b154f (patch)
treee1240767a26261bed8a0bcbbdb31850ad8b38d4e /README.md
parent9603960eeea6b06c5184850c2c2af7d257c77fdd (diff)
feat(release): hexai-first AI release notes; chore(version): bump to 0.8.8v0.8.8
- Prefer hexai stdin pipeline for release notes generation - Fallback to Claude then aichat - Update CLI help and README - Adjust integration tests for current CLI
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index f56554b..9feb08d 100644
--- a/README.md
+++ b/README.md
@@ -177,6 +177,13 @@ gitsyncer release create myproject --no-ai-notes
gitsyncer release create --ai-tool aichat
```
+#### AI Release Notes Engines
+
+- Default flow: tries `hexai` first by piping the generated commit/diff payload to stdin and passing an instruction prompt as the sole argument (equivalent to `cat SOMETEXT.txt | hexai PROMPT`).
+- Fallback: if `hexai` is not available or fails, falls back to `claude --model sonnet`, then to `aichat`.
+- Explicit tool: `--ai-tool claude` or `--ai-tool aichat` influences the fallback preference, but `hexai` is still attempted first when available.
+- Requirements: ensure `hexai`, `claude`, or `aichat` are installed and available in `PATH`.
+
### Project Showcase
```bash