Greg Gauthier
cd47686679
- 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.
2.5 KiB
2.5 KiB
Grokkit User's Guide
Welcome to the full user documentation for Grokkit — a fast, native Go CLI for Grok that supercharges your coding workflow.
Quick Navigation
🛡️ Safety & Change Management
- Safety & Change Management — Learn how Grokkit integrates with Git to keep your codebase stable and safe.
🔄 Workflows
- Grokkit Workflows — Learn how to integrate Grokkit into your development cycle effectively.
Core Commands
- 👨🍳 Recipe — The star of the show. Run powerful, transactional, multi-step LLM workflows defined in simple markdown files.
- 🤖 Agent — Multi-file agent for complex refactorings and project-wide changes.
- 🏗️ Scaffold — Safely generate new files with Grok preview + confirmation.
- 🧪 Testgen — Generate high-quality unit tests for Go, Python, C/C++, etc.
- ✏️ Edit — In-place file editing with Grok (safe preview mode).
Git Workflow Commands
- ✅ Commit — AI-powered conventional commit messages with direct git commit.
- 📝 Commit-Msg — Generate AI-suggested conventional commit messages.
- 🗒️ Changelog — Generate CHANGELOG.md from git history.
- 📋 PR-Describe — Generate full PR descriptions.
- 📜 History — Summarize recent git history.
Other Useful Commands
- 💬 Chat — Full interactive chat with history and streaming
- 🤖 Query — One-shot programming-focused queries
- 🔍 Review — AI code review of the current repo/directory
- 🔧 Lint — Lint + AI-suggested fixes
- 📖 Docs — Generate documentation comments
- Completion — Generate shell completion scripts
- 🏷️ Version — Print version information
Getting Started
See the main README for installation and basic usage.
See the Configuration Guide for detailed information on how to configure Grokkit via environment variables and config files.
Want to dive deep? Start with the Recipe Guide — it's the most powerful and unique feature of Grokkit.
Contributing to the Docs
Found something missing or unclear? Feel free to open a PR or issue on the repo.
Happy hacking!