grammr

README

grammr

Lightning-fast AI grammar checker in your terminal ⚡

grammr (yes, it's misspelled on purpose) is a blazingly fast TUI grammar checker powered by OpenAI. Copy text from anywhere, fix it in seconds, and paste it back. No UI, no bloat, just speed.

Why grammr?

• Fast: Sub-3-second workflow from copy to paste
• Keyboard-only: Vim-inspired keybindings
• AI-powered: GPT-4o quality beats rule-based checkers
• Offline cache: Already-checked text loads instantly
• Beautiful: Colorful diffs, clean interface
• Private: Runs locally, API calls only for corrections

Install

Homebrew (macOS)

Option 1: Direct installation (recommended)

brew tap maximbilan/grammr https://github.com/maximbilan/grammr
brew install grammr

Option 2: Using the installation script

curl -fsSL https://raw.githubusercontent.com/maximbilan/grammr/main/install.sh | bash

Or for a specific version:

curl -fsSL https://raw.githubusercontent.com/maximbilan/grammr/main/install.sh | bash -s v1.0.0

Option 3: Direct formula URL

brew install --build-from-source https://raw.githubusercontent.com/maximbilan/grammr/v1.0.0/Formula/grammr.rb

Replace v1.0.0 with the desired version tag.

Go Install

go install github.com/maximbilan/grammr@latest

Build from Source

git clone https://github.com/maximbilan/grammr
cd grammr
go build -o grammr

Setup

1. Get an API key from OpenAI
2. Initialize configuration (optional, creates config directory):

grammr config init

1. Configure grammr:

grammr config set api_key YOUR_API_KEY

Optional: Choose a model (default: gpt-4o)

grammr config set model gpt-4o-mini  # Faster and cheaper

Optional: Set language (default: english)

grammr config set language spanish  # For Spanish text correction

Usage

1. Copy text from anywhere (Cmd+C / Ctrl+C)
2. Run grammr
3. Press V to paste
4. Wait ~1s for AI correction
5. Press C to copy result
6. Paste back to your app (Cmd+V / Ctrl+V)

That's it! 🎉

Keyboard Shortcuts

Global Mode:

Key	Action
V	Paste from clipboard
C	Copy corrected text
E	Edit corrected text
O	Edit original text
R	Retry correction
D	Toggle diff view
A	Review changes word-by-word
Q	Quit
Ctrl+V	Paste & auto-correct
Ctrl+C	Copy & quit
? or F1	Show help

Edit Mode:

Key	Action
Esc	Exit edit mode
Ctrl+S	Save and re-correct (original only)

Review Mode:

Key	Action
Tab	Apply current change
Space	Skip current change
Esc	Exit review mode

Modes

Switch correction styles:

• 1 - Casual (default)
• 2 - Formal
• 3 - Academic
• 4 - Technical

Configuration

Edit ~/.grammr/config.yaml:

api_key: "sk-..."
model: "gpt-4o"  # or gpt-4o-mini
mode: "casual"
language: "english"  # Default: english. Options: english, spanish, french, german, etc.
cache_enabled: true
cache_ttl_days: 7
show_diff: true
auto_copy: false

Or use the CLI:

grammr config set model gpt-4o-mini
grammr config set language spanish
grammr config get language

Model Comparison

Model	Speed	Cost	Quality
gpt-4o	Fast	Medium	Excellent
gpt-4o-mini	Very Fast	Cheap	Very Good

Recommendation: Start with gpt-4o-mini for speed and cost, upgrade to gpt-4o if you need better quality.

Examples

Quick fix:

grammr
# Press V, wait, press C

Change mode:

# Press 2 for formal writing
# Press V to paste

Review changes word-by-word:

grammr
# Press V to paste
# Press A to enter review mode
# Press Tab to apply changes, Space to skip
# Press Esc when done

Clear cache:

rm -rf ~/.grammr/cache/

Initialize config:

grammr config init

Features

• ✅ Real-time streaming corrections
• ✅ Smart caching (hash-based, configurable TTL)
• ✅ Beautiful colored diffs
• ✅ Word-by-word change review mode
• ✅ Multiple writing modes (casual, formal, academic, technical)
• ✅ Inline text editing
• ✅ Vim-inspired keybindings
• ✅ Cross-platform (macOS, Linux, Windows)
• ✅ Single binary, no dependencies
• ✅ Comprehensive test suite

Why the weird name?

Because a grammar checker with a misspelled name is hilariously ironic. Also, it's shorter to type. 😄

Development

Running Tests

go test ./...

Building

go build -o grammr

Test Coverage

The project includes comprehensive unit tests covering:

• Cache operations (hash, get, set, expiration)
• Configuration management (load, save, set, get)
• Corrector initialization and prompt building
• UI utility functions (diff parsing, text building, whitespace trimming)

Roadmap

• Support for Anthropic Claude (in addition to OpenAI)
• Custom system prompts
• Plugin system for custom corrections
• Multi-language support
• Batch file processing

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

See LICENSE file for details.