Skip to content

Configuration

Complete settings and customization guide.

API Provider Setup

OpenAI

  1. Get API key: platform.openai.com/api-keys
  2. In app Settings (⚙️): Select OpenAI
  3. Paste API key
  4. (Optional) Change model from default gpt-5-nano

Available models: gpt-4o-mini, gpt-4o, gpt-4, gpt-3.5-turbo, etc.

Google Gemini

  1. Get API key: aistudio.google.com/apikey
  2. In app Settings (⚙️): Select Gemini
  3. Paste API key
  4. (Optional) Change model from default gemini-2.5-flash

Available models: gemini-2.5-flash, gemini-1.5-pro, gemini-pro, etc.

WARNING

Never share your API key or commit it to version control!

Custom Enhancement Options

Create up to 5 custom prompts for specific needs.

How to Add

  1. Settings (⚙️) → Scroll to "Custom Enhancement Options"
  2. Click Add Custom Option
  3. Enter:
    • Label: Button name (e.g., "Add Emojis")
    • Prompt: AI instruction (e.g., "Add relevant emojis")
  4. Click Add

Optimization Tips

Keep prompts 2-5 words:

  • ✅ "Add emojis"
  • ✅ "Simplify for beginners"
  • ✅ "Remove jargon"
  • ❌ "Please make this text more simple and easy to understand"

Why? Shorter = Faster + Cheaper

Example Prompts

  • "Add emojis"
  • "Simplify technical terms"
  • "Make persuasive"
  • "Add bullet points"
  • "Remove passive voice"

Token Usage Tracking

Monitor API costs in real-time.

What's Tracked

  • Input/output tokens per request
  • Estimated cost (OpenAI pricing)
  • Cumulative totals

Where to View

  • Main window: Current session
  • Settings: Full history
  • Reset button: Clear all data

Data Storage

Settings Location

~/Library/Application Support/com.kitelus.grammar-assistant/

What's Stored Locally

  • API keys (secure)
  • Provider preferences
  • Custom enhancement options
  • Token usage statistics

What's NOT Stored

  • ❌ Your text content
  • ❌ AI responses
  • ❌ Usage analytics

Token Usage Tracking

Monitor your API usage and costs:

  • Real-time tracking: See tokens used per request
  • Cost estimates: Approximate costs for OpenAI
  • Total statistics: View cumulative usage
  • Reset stats: Clear tracking data anytime

Access from settings or view in the main interface.

Global Shortcut

The keyboard shortcut is Cmd+Shift+G (fixed, not customizable).

How it works:

  1. Select text in any app
  2. Press Cmd+Shift+G
  3. Grammar Assistant opens with your text
  4. Choose enhancement mode
  5. Copy and paste result back

Privacy & Data

Data Collection

Grammar Assistant respects your privacy:

  • ✅ Text only sent when you press Cmd+Shift+G
  • ✅ No automatic text collection
  • ✅ No analytics or tracking
  • ✅ API keys stored locally only
  • ✅ No cloud storage

Local Storage

Settings are stored at:

~/Library/Application Support/com.kitelus.grammar-assistant/

Released under the MIT License. | Report issues: thanhbinh.bent@gmail.com