docs(README): update version info, installation details, and project structure
- Update Go version to 1.24.2 in badge and requirements - Change repository URL to repos.gmgauthier.com - Update example VERSION to 0.1.3 - Revise model alias for "fast" - Add testing and linting instructions in Development section - Expand directory structure with new internal packages and files
This commit is contained in:
parent
68df041a09
commit
a9127deedd
40
README.md
40
README.md
@ -4,7 +4,7 @@ Grokkit is a fast Go CLI integrating Grok AI with git workflows and general chat
|
||||
|
||||
|
||||
[]()
|
||||
[]()
|
||||
[]()
|
||||
[]()
|
||||
|
||||
## 🚀 Quick Start
|
||||
@ -14,7 +14,7 @@ Grokkit is a fast Go CLI integrating Grok AI with git workflows and general chat
|
||||
export XAI_API_KEY=sk-...
|
||||
|
||||
# Install from source
|
||||
git clone https://github.com/yourusername/grokkit.git
|
||||
git clone https://repos.gmgauthier.com/gmgauthier/grokkit.git
|
||||
cd grokkit
|
||||
make install
|
||||
|
||||
@ -26,7 +26,7 @@ grokkit --help
|
||||
|
||||
### From pre-built release (recommended)
|
||||
```bash
|
||||
VERSION=1.0.0 # Replace with latest version tag (omit 'v')
|
||||
VERSION=0.1.3 # Replace with latest version tag (omit 'v')
|
||||
curl -L https://repos.gmgauthier.com/gmgauthier/grokkit/releases/download/v${VERSION}/grokkit-install.sh | VERSION=${VERSION} bash -
|
||||
```
|
||||
Verify:
|
||||
@ -209,7 +209,7 @@ log_level = "info" # debug, info, warn, error
|
||||
|
||||
[aliases]
|
||||
beta = "grok-beta-2"
|
||||
fast = "grok-4-mini"
|
||||
fast = "grok-4-1-fast-non-reasoning"
|
||||
|
||||
[chat]
|
||||
history_file = "~/.config/grokkit/chat_history.json"
|
||||
@ -401,13 +401,23 @@ grokkit review -v
|
||||
## Development
|
||||
|
||||
```bash
|
||||
# All tests pass without XAI_API_KEY (unit tests only)
|
||||
|
||||
# Run tests
|
||||
make test
|
||||
|
||||
# Agent-specific tests
|
||||
make test-agent
|
||||
|
||||
# Run tests with coverage report
|
||||
make test-cover
|
||||
open build/coverage.html
|
||||
|
||||
# Linting (matches CI)
|
||||
make lint
|
||||
# Install golangci-lint if needed:
|
||||
# go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
|
||||
|
||||
# Run specific tests
|
||||
go test -run TestEditCommand ./cmd -v
|
||||
|
||||
@ -425,16 +435,20 @@ make clean
|
||||
|
||||
```
|
||||
grokkit/
|
||||
├── cmd/ # CLI commands (cobra)
|
||||
├── config/ # Configuration management (viper)
|
||||
├── cmd/ # CLI commands (Cobra)
|
||||
├── config/ # Viper configuration
|
||||
├── docs/ # Documentation
|
||||
├── internal/
|
||||
│ ├── errors/ # Custom error types
|
||||
│ ├── git/ # Git operations wrapper
|
||||
│ ├── grok/ # Grok API client
|
||||
│ └── logger/ # Structured logging (slog)
|
||||
├── docs/ # Documentation
|
||||
├── .gitea/ # CI/CD workflows
|
||||
└── Makefile # Build automation
|
||||
│ ├── git/ # Git operations
|
||||
│ ├── grok/ # xAI Grok API client
|
||||
│ ├── linter/ # Multi-language linting
|
||||
│ ├── logger/ # Structured slog logging
|
||||
│ └── version/ # Build/version info
|
||||
├── main.go # Application entrypoint
|
||||
├── go.mod # Dependencies
|
||||
├── Makefile # Build automation
|
||||
└── scripts/ # Install scripts
|
||||
```
|
||||
|
||||
## Documentation
|
||||
@ -453,7 +467,7 @@ Grokkit uses the xAI Grok API. Be aware:
|
||||
|
||||
## Requirements
|
||||
|
||||
- Go 1.24+ (for building)
|
||||
- Go 1.24.2 (for building)
|
||||
- Git (for git-related commands)
|
||||
- XAI API key
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user