gmgauthier/grokkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

docs(README): add section for grokkit changelog command
Some checks failed
CI / Test (push) Failing after 26s
Details
CI / Lint (push) Has been skipped
Details
CI / Build (push) Has been skipped
Details

Browse Source 
Document the new `grokkit changelog` command, including usage examples for generating changelog sections suitable for Gitea release notes.
This commit is contained in:
Greg Gauthier 2026-03-03 22:06:45 +00:00
parent ce5367c3a7
commit db96cf5229
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -157,6 +157,24 @@ Summarize recent git commits.
grokkit history # Last 10 commits grokkit history # Last 10 commits
``` ```
### 🗒️ `grokkit changelog`
Generate a clean `CHANGELOG.md` section from git history, designed specifically so the output can be pasted directly into Gitea release notes.
```bash
# 1. Create your version tag first
git tag v0.2.0
# 2. Generate preview + write (with safety confirmation)
grokkit changelog
# 3. Output ONLY the new section (perfect for Gitea "Release notes")
grokkit changelog --stdout
# 4. Write file + get commit reminder
grokkit changelog --commit
```
### 📖 `grokkit docs <file> [file...]` ### 📖 `grokkit docs <file> [file...]`
Generate language-appropriate documentation comments using Grok AI. Generate language-appropriate documentation comments using Grok AI.