Supported Browsers

Installation - Chrome

Step 1: Build the Extension

# Navigate to extension folder
cd opengrammar/opengrammar/extension

# Install dependencies
bun install

# Build for production
bun run build

Step 2: Load in Chrome

1. Open Chrome
2. Navigate to chrome://extensions/
3. Enable Developer mode (toggle in top-right corner)
4. Click Load unpacked
5. Select the opengrammar/extension/dist folder
6. Click Select

Initial Configuration

Step 1: Open Settings

1. Click the OpenGrammar icon in your toolbar
2. Click the Settings (gear) icon

Step 2: Configure Backend URL

Enter your backend URL based on your deployment:

• Local: http://localhost:8787
• Cloudflare: https://opengrammar.yourname.workers.dev
• Vercel: https://opengrammar-backend.vercel.app
• Railway: https://your-app.railway.app
• Render: https://opengrammar-backend.onrender.com
• Docker: http://localhost:8787

Step 3: Configure AI Provider

User Interface

Color-Coded Underlines

Key Features

Features

• Works Everywhere: Seamlessly integrates into text inputs, textareas, and rich text editors (like Gmail, Google Docs, Notion, and Reddit).
• Blazing Fast: Built with modern web technologies (React, Vite, Manifest V3) for minimal performance impact.
• Dual-Engine Architecture:
  • Rule-Based (Free & Offline): Catches passive voice, repeated words, and overly long sentences.
  • AI-Powered (Requires API Key): Advanced grammar, spelling, clarity, and stylistic suggestions.
• Tone & Style Rewriting: Right-click context menus or shortcuts to quickly rewrite text in 8 different tones.
• Writing Statistics: Built-in dashboard for readability scores, reading time, and vocabulary diversity.
• Intuitive UI: Familiar red, yellow, and blue underlines with click-to-apply suggestions.

Cloudflare Workers (Recommended)

Prerequisites

• Cloudflare account (free)
• Node.js 18+

Step 1: Install Wrangler CLI

npm install -g wrangler

Step 2: Login to Cloudflare

wrangler login

Step 3: Configure Environment

cd opengrammar/opengrammar/backend

# Create .dev.vars for local development
cat > .dev.vars << EOF
DEBUG=true
GROQ_API_KEY=your_groq_key
OPENAI_API_KEY=your_openai_key
EOF

Step 4: Deploy

# Deploy to production
wrangler deploy --env production

Step 5: Get Your URL

After deployment, you'll see:

Deployed https://opengrammar.yourname.workers.dev

Vercel

Step 1: Install Vercel CLI

npm install -g vercel

Step 2: Deploy

cd opengrammar/opengrammar/backend
vercel --prod

Docker Self-Hosting

Option 1: Docker Compose

cd opengrammar/opengrammar

# Start backend only
docker-compose up -d opengrammar-backend

# Start with Ollama (local LLM)
docker-compose --profile local-llm up -d

Quick Start

Option 1: Backend Only (Use Cloud APIs)

cd opengrammar/opengrammar

# Create environment file
cat > .env << EOF
PORT=8787
NODE_ENV=production
GROQ_API_KEY=your_groq_key
OPENAI_API_KEY=your_openai_key
EOF

# Start backend
docker-compose up -d opengrammar-backend

# Check status
docker-compose ps

# View logs
docker-compose logs -f opengrammar-backend

Option 2: Backend + Ollama (Local LLM)

cd opengrammar/opengrammar

# Start everything (requires NVIDIA GPU)
docker-compose --profile local-llm up -d

Local LLM Setup with Ollama

Step 1: Start Ollama Container

docker-compose --profile local-llm up -d ollama

Step 2: Pull Grammar-Focused Models

# Enter Ollama container
docker exec -it opengrammar-ollama bash

# Pull models (inside container)
ollama pull qwen2.5:0.5b      # Ultra fast, 400MB
ollama pull qwen2.5:1.5b      # Balanced, 1GB
ollama pull phi4-mini:3.8b    # Great quality, 2.5GB
ollama pull llama3.2:3b       # Good all-rounder, 2GB

# Exit container
exit

Model Recommendations

Overview

OpenGrammar supports 6 AI providers, giving you flexibility in cost, quality, and privacy.

Groq (Recommended - Free)

Step 1: Create Account

1. Visit Groq Console
2. Click Sign Up
3. Complete registration

Step 2: Get API Key

1. Go to API Keys in left sidebar
2. Click Create API Key
3. Give it a name (e.g., "OpenGrammar")
4. Copy the key (starts with gsk_)

Step 3: Configure in Extension

1. Click OpenGrammar icon → Settings
2. Provider: Groq
3. API Key: gsk_xxx (paste your key)
4. Model: llama-3.1-70b-versatile
5. Click Save

Grammar Checking

Color-Coded Underlines

Using Grammar Checking

1. Start Typing - Open any text input (Gmail, Google Docs, Notion, etc.)
2. Watch for Underlines - As you type, OpenGrammar automatically checks
3. Review Suggestions - Click any underlined text to see suggestions
4. Apply Changes - Click Apply, Ignore, or Add to Dictionary

Tone Rewriting

Available Tones

Available Tones

How to Use

Method 1: Right-Click Menu

1. Select text you want to rewrite
2. Right-click
3. Choose "Rewrite with OpenGrammar"
4. Choose tone and see preview
5. Apply or Copy result

Method 2: Keyboard Shortcut

1. Select text
2. Press Ctrl+Shift+R (Windows/Linux) or Cmd+Shift+R (Mac)
3. Choose tone
4. Apply changes

Available Metrics

Readability Scores

Time Estimates

• Reading Time: Words ÷ 200 words per minute
• Speaking Time: Words ÷ 150 words per minute

Default Shortcuts

Common Issues

No Grammar Highlights

Backend Connection Failed

AI Not Working

Endpoints

Health Check

Returns the health status of the backend service.

curl http://localhost:8787/health

Response

{
  "status": "healthy",
  "timestamp": "2026-03-20T12:00:00.000Z",
  "environment": "production",
  "version": "2.0.0"
}

Analyze Text

Analyze text for grammar, spelling, clarity, and style issues.

curl -X POST http://localhost:8787/analyze \
  -H "Content-Type: application/json" \
  -d '{
    "text": "me and him went to store",
    "apiKey": "your-api-key",
    "provider": "groq",
    "model": "llama-3.1-70b-versatile"
  }'

Request Body

Rewrite Text

Rewrite text in different tones.

curl -X POST http://localhost:8787/rewrite \
  -H "Content-Type: application/json" \
  -d '{
    "text": "hey whats up",
    "tone": "formal",
    "apiKey": "your-api-key"
  }'

Response

{
  "original": "hey whats up",
  "rewritten": "Greetings, how are you?",
  "tone": "formal"
}