82 lines
1.2 KiB
Markdown
82 lines
1.2 KiB
Markdown
# Grokkit
|
|
|
|
Grokkit is a fast Go CLI integrating Grok AI with git workflows and general chat/edit.
|
|
|
|
## 🚀 Quick Start
|
|
|
|
```bash
|
|
export XAI_API_KEY=sk-...
|
|
|
|
go install gmgauthier.com/grokkit@grokkit # or build locally
|
|
|
|
grokkit --help
|
|
```
|
|
|
|
## 📁 Config (optional)
|
|
|
|
`~/.config/grokkit/grokkit.yaml`:
|
|
```yaml
|
|
model: grok-4
|
|
chat:
|
|
history_file: ~/.config/grokkit/chat_history.json
|
|
```
|
|
|
|
## Commands
|
|
|
|
### 💬 `grokkit chat`
|
|
Interactive TUI chat with Grok (bubbletea: styled scrolling viewport, live streaming, mouse support).
|
|
|
|
```
|
|
grokkit chat
|
|
```
|
|
|
|
### 📝 `grokkit commitmsg`
|
|
Generate conventional commit from staged changes.
|
|
|
|
```
|
|
git add .
|
|
grokkit commitmsg
|
|
```
|
|
|
|
### ✅ `grokkit commit`
|
|
Generate & commit.
|
|
|
|
```
|
|
grokkit commit
|
|
```
|
|
|
|
### 🔍 `grokkit review`
|
|
AI code review of staged changes.
|
|
|
|
```
|
|
grokkit review
|
|
```
|
|
|
|
### 📋 `grokkit pr-describe`
|
|
PR description from branch vs main.
|
|
|
|
```
|
|
grokkit pr-describe
|
|
```
|
|
|
|
### 📜 `grokkit history`
|
|
Summarize recent commits.
|
|
|
|
```
|
|
grokkit history
|
|
```
|
|
|
|
### ✏️ `grokkit edit FILE "instruction"`
|
|
AI edit file.
|
|
|
|
```
|
|
grokkit edit main.go "add error handling"
|
|
```
|
|
|
|
## Flags
|
|
|
|
`--model, -m`: grok-4 (default), etc.
|
|
|
|
## License
|
|
|
|
[Unlicense](https://unlicense.org/) |