docs: add grokkit query command documentation to README
- Added entry to commands list - Created new section with usage examples and features
This commit is contained in:
parent
cc6a2f642f
commit
587be3a046
20
README.md
20
README.md
@ -38,6 +38,7 @@ grokkit version
|
|||||||
|
|
||||||
- [Commands](#commands)
|
- [Commands](#commands)
|
||||||
- [chat](#-grokkit-chat)
|
- [chat](#-grokkit-chat)
|
||||||
|
- [query](#-grokkit-query)
|
||||||
- [edit](#-grokkit-edit-file-instruction)
|
- [edit](#-grokkit-edit-file-instruction)
|
||||||
- [commit / commitmsg](#-grokkit-commitmsg)
|
- [commit / commitmsg](#-grokkit-commitmsg)
|
||||||
- [review](#-grokkit-review)
|
- [review](#-grokkit-review)
|
||||||
@ -72,6 +73,25 @@ grokkit chat --debug # Enable debug logging
|
|||||||
- History is saved automatically between sessions
|
- History is saved automatically between sessions
|
||||||
- Use `--debug` to see API request timing
|
- Use `--debug` to see API request timing
|
||||||
|
|
||||||
|
### 🤖 `grokkit query`
|
||||||
|
|
||||||
|
One-shot technical question answering. Perfect for quick programming or engineering questions.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Basic usage
|
||||||
|
grokkit query "How do I sort a slice of structs by a field in Go?"
|
||||||
|
|
||||||
|
# Longer, more detailed answer
|
||||||
|
grokkit query --wordy "Explain how Go's context package works with cancellation"
|
||||||
|
```
|
||||||
|
Features:
|
||||||
|
|
||||||
|
Default mode is concise, factual, and actionable
|
||||||
|
--wordy flag gives longer, more explanatory answers
|
||||||
|
Uses the fast non-reasoning model by default for speed
|
||||||
|
No persistent history or interactive chat UI
|
||||||
|
|
||||||
|
|
||||||
### ✏️ `grokkit edit FILE "instruction"`
|
### ✏️ `grokkit edit FILE "instruction"`
|
||||||
AI-powered file editing with preview.
|
AI-powered file editing with preview.
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user