# 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](safety.md)** โ€” Learn how Grokkit integrates with Git to keep your codebase stable and safe. ### ๐Ÿ”„ Workflows - **[Grokkit Workflows](workflows.md)** โ€” Learn how to integrate Grokkit into your development cycle effectively. ### Core Commands - **[๐Ÿ‘จโ€๐Ÿณ Recipe](recipe.md)** โ€” The star of the show. Run powerful, transactional, multi-step LLM workflows defined in simple markdown files. - **[๐Ÿค– Agent](agent.md)** โ€” Multi-file agent for complex refactorings and project-wide changes. - **[๐Ÿ—๏ธ Scaffold](scaffold.md)** โ€” Safely generate new files with Grok preview + confirmation. - **[๐Ÿงช Testgen](testgen.md)** โ€” Generate high-quality unit tests for Go, Python, C/C++, etc. - **[โœ๏ธ Edit](edit.md)** โ€” In-place file editing with Grok (safe preview mode). ### Git Workflow Commands - **[โœ… Commit](commit.md)** โ€” AI-powered conventional commit messages with direct git commit. - **[๐Ÿ“ Commit-Msg](commit-msg.md)** โ€” Generate AI-suggested conventional commit messages. - **[๐Ÿ—’๏ธ Changelog](changelog.md)** โ€” Generate CHANGELOG.md from git history. - **[๐Ÿ“‹ PR-Describe](pr-describe.md)** โ€” Generate full PR descriptions. - **[๐Ÿ“œ History](history.md)** โ€” Summarize recent git history. ### Other Useful Commands - **[๐Ÿ’ฌ Chat](chat.md)** โ€” Full interactive chat with history and streaming - **[๐Ÿค– Query](query.md)** โ€” One-shot programming-focused queries - **[๐Ÿ” Review](review.md)** โ€” AI code review of the current repo/directory - **[๐Ÿ”ง Lint](lint.md)** โ€” Lint + AI-suggested fixes - **[๐Ÿ“– Docs](docs.md)** โ€” Generate documentation comments - **[Completion](completion.md)** โ€” Generate shell completion scripts - **[๐Ÿท๏ธ Version](version.md)** โ€” Print version information --- ## Getting Started See the [main README](../README.md) for installation and basic usage. See the [Configuration Guide](../developer-guide/CONFIGURATION.md) for detailed information on how to configure Grokkit via environment variables and config files. Want to dive deep? Start with the **[Recipe Guide](recipe.md)** โ€” 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!