- Simplified README.md by moving detailed command docs, workflows, and development info to dedicated user-guide/ and developer-guide/ directories. - Created index.md files for both guides to improve navigation. - Extracted individual command guides (e.g., chat.md, edit.md) into user-guide/ for focused, maintainable documentation. - Moved architecture, configuration, and troubleshooting to developer-guide/. - Updated README links to point to the new docs structure.
1.2 KiB
1.2 KiB
📜 History Guide
The history command provides a concise, AI-generated summary of your recent git history. It analyzes the last 10 commits to give you a high-level overview of recent developments.
Key Features
- Quick Summaries: Get a quick catch-up on what's been happening in the repo.
- AI-Powered Analysis: Grok translates individual commit messages into 3-5 high-level bullet points.
- Fast and Efficient: A one-shot command for immediate results.
Usage
grokkit history # Last 10 commits
Options
| Flag | Description |
|---|---|
--model, -m |
Override the default model (e.g., grok-4) |
How it Works
- Commit Log: Grokkit runs
git log --oneline -10to get the 10 most recent commits. - AI Analysis: It sends this log to Grok with a prompt to summarize the history.
- Bullet Point Summary: Grok returns a 3-5 point summary of the most important changes.
When to use History
- Catching up: Use
historyafter pulling from the remote to see what's changed. - Branch review: Use it to quickly recall what you've worked on recently.
- Project overview: Great for getting a quick status update on a project you haven't touched in a few days.