Poly-Glot AI automatically reviews your pull requests and suggests professional documentation comments for undocumented code. When you open or update a PR, the app:

1. 🔍 Scans changed files for missing documentation
2. 📊 Analyzes documentation coverage per file
3. 🤖 Generates doc comments using OpenAI or Anthropic
4. 💬 Posts inline review suggestions directly on your PR
5. ✅ Reports a Check Run with coverage metrics

👉 Install Poly-Glot AI on your repositories.

Add a .polyglot.yml to your repository root:

# AI provider: 'openai' or 'anthropic'
provider: openai

# Comment mode: 'doc', 'why', or 'both'
# - doc: Standard documentation comments (JSDoc, PyDoc, etc.)
# - why: Explain reasoning, trade-offs, and edge cases
# - both: Both doc comments and why-comments
mode: both

# Only suggest docs for files below this coverage threshold (0.0–1.0)
coverage_threshold: 0.5

# Maximum files to process per PR
max_files: 15

# Maximum file size in bytes
max_file_size: 50000

# Review style: 'inline' (per-file suggestions) or 'summary' (single comment)
review_style: inline

# Include/exclude file patterns
include: []
exclude:
  - "**/*.test.*"
  - "**/*.spec.*"
  - "**/vendor/**"

# Create a GitHub Check Run with coverage analysis
check_run: true

That's it! Poly-Glot AI will automatically analyze your PR and post documentation suggestions.

🎁 Use code EARLYBIRD3 for 50% off your first 3 months on Pro

→ View all plans at poly-glot.ai

After subscribing, add your license token to .polyglot.yml to unlock Pro/Team features:

license_token: YOUR_TOKEN_HERE

Get your token at poly-glot.ai/dashboard → Account → License Token.

Generates standard documentation comments — parameters, return types, exceptions:

/**
 * Authenticate a user with email and password.
 * @param {string} email - The user's email address
 * @param {string} password - The user's password (plaintext, hashed internally)
 * @returns {Promise<AuthResult>} Authentication result with token and user profile
 * @throws {AuthenticationError} If credentials are invalid
 */
async function authenticateUser(email, password) { ... }

Explains the reasoning behind code decisions:

// Why: Rate-limit auth attempts per IP to prevent credential stuffing.
// 5 attempts/min was chosen based on OWASP guidelines.
// Uses sliding window instead of fixed to prevent burst attacks at window edges.
if (await isRateLimited(ip, 5, 60)) { ... }

Combines doc comments AND why-comments for maximum context.

• Your code stays private — the app reads PR diffs only for analysis
• Your API key — uses your own OpenAI or Anthropic key
• No data retention — code is processed in memory, never stored
• Open source — audit every line of this app

See PRIVACY.md for our full privacy policy.

You can self-host the Poly-Glot AI GitHub App:

# Clone the repo
git clone https://github.com/hmoses/poly-glot-github-app.git
cd poly-glot-github-app

# Configure
cp .env.example .env
# Edit .env with your GitHub App credentials and API keys

# Run
docker-compose up -d

git clone https://github.com/hmoses/poly-glot-github-app.git
cd poly-glot-github-app
npm install
cp .env.example .env
# Edit .env with your credentials
npm start

Poly-Glot AI is available across multiple platforms:

MIT — Harold Moses / Poly-Glot AI