gmgauthier/grokkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 23 Wiki Activity

docs(readme): update version to 0.3.5 and improve section headings
All checks were successful
CI / Test (push) Successful in 33s
Details
CI / Lint (push) Successful in 23s
Details
CI / Build (push) Successful in 21s
Details

Browse Source 
- Bump version references from 0.3.3 to 0.3.5 in installation scripts
- Convert plain text sections to Markdown headings for better readability
This commit is contained in:
Gregory Gauthier 2026-03-30 14:29:16 +01:00
parent 363a761187
commit 0c8ec610b8
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -19,13 +19,13 @@ Grokkit is a fast Go CLI integrating Grok AI with git workflows and general chat
**Bash (Linux/macOS):** **Bash (Linux/macOS):**
```bash ```bash
export VERSION=0.3.3 export VERSION=0.3.5
curl -fsSL https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v${VERSION}/grokkit-install.sh | bash -s -- --verify curl -fsSL https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v${VERSION}/grokkit-install.sh | bash -s -- --verify
``` ```
**PowerShell (Windows):** **PowerShell (Windows):**
```pwsh ```pwsh
$env:VERSION="0.3.3" $env:VERSION="0.3.5"
irm https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v$env:VERSION/grokkit-install.ps1 | iex irm https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v$env:VERSION/grokkit-install.ps1 | iex
``` ```
@ -40,7 +40,7 @@ Both installers feature:
**Bash (Linux/macOS):** **Bash (Linux/macOS):**
```bash ```bash
export VERSION=0.3.3 export VERSION=0.3.5
curl -fsSL https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v${VERSION}/grokkit-install.sh -o grokkit-install.sh curl -fsSL https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v${VERSION}/grokkit-install.sh -o grokkit-install.sh
bash grokkit-install.sh --verify bash grokkit-install.sh --verify
``` ```
@ -48,7 +48,7 @@ bash grokkit-install.sh --verify
**PowerShell (Windows):** **PowerShell (Windows):**
```pwsh ```pwsh
$env:VERSION="0.3.3" $env:VERSION="0.3.5"
irm https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v$env:VERSION/grokkit-install.ps1 -OutFile grokkit-install.ps1 irm https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v$env:VERSION/grokkit-install.ps1 -OutFile grokkit-install.ps1
.\grokkit-install.ps1 -Verify .\grokkit-install.ps1 -Verify
``` ```
@ -156,20 +156,20 @@ Generate shell completions for faster command entry:
### Examples ### Examples
# Use different model #### Use different model
`grokkit chat -m grok-beta` `grokkit chat -m grok-beta`
# Debug API issues #### Debug API issues
`grokkit edit main.go "refactor" --debug` `grokkit edit main.go "refactor" --debug`
# Verbose logging #### Verbose logging
`grokkit review -v` `grokkit review -v`
## Features #### Features
### Core Features ### Core Features
- ✅ **Structured logging with slog** - JSON logs with request tracing, timing, and context - ✅ **Structured logging with slog** - JSON logs with request tracing, timing, and context
@ -235,15 +235,15 @@ Grokkit uses the xAI Grok API. Be aware:
**Common issues:** **Common issues:**
# API key not set ### API key not set
Error: XAI_API_KEY environment variable not set Error: XAI_API_KEY environment variable not set
→ Solution: `export XAI_API_KEY=sk-your-key` → Solution: `export XAI_API_KEY=sk-your-key`
# Request timeout ### Request timeout
Error: Request failed: context deadline exceeded Error: Request failed: context deadline exceeded
→ Solution: Increase timeout in `config.toml` or check network → Solution: Increase timeout in `config.toml` or check network
# Permission denied on log file ### Permission denied on log file
→ Solution: `chmod 644 ~/.config/grokkit/grokkit.log` → Solution: `chmod 644 ~/.config/grokkit/grokkit.log`