Skip to content

jpchavat/correctIA

Repository files navigation

CorrectIA Logo

CorrectIA

CorrectIA is a macOS menu bar app that improves English text with minimal edits (or clarity improvements if you choose), highlights changes inline, and explains each change with a short reason.

Features

  • Menu bar app with one-click correction
  • Clipboard auto-load and optional auto-correct for short texts
  • Inline highlighted corrections
  • Bullet list explanations with icons (grammar, punctuation, spelling, style, clarity)
  • Global hotkey to copy selection → correct → show results
  • Model selection (GPT-5 mini / GPT-5 nano)
  • API key stored securely in macOS Keychain
  • Local settings: font size, correction style, auto-correct threshold, hotkey

How it works

  1. You copy or select text.
  2. CorrectIA loads the clipboard (and optionally auto-corrects if under the threshold).
  3. The app calls OpenAI with structured output so it can render changes precisely.
  4. The corrected text is shown with highlights, and each change is explained in the summary.

Setup 🚀

Recommended (non‑technical): Download the .app

Go to GitHub Releases and download the latest correctIA-vX.Y.Z.zip. Unzip and move the app to Applications, then open it.

Advanced (developers): Build locally

For development:

swift run

For a local app bundle (recommended for permissions):

./scripts/make_app.sh
open ./dist/correctIA-last-dev.app

Set your API key 🔑

Open Settings in the menu and paste your OpenAI API key. It's stored securely in your macOS Keychain.

Permissions (macOS) 🔐

CorrectIA uses a global hotkey and simulates ⌘C to capture selected text. macOS will require:

  • Accessibility
  • Input Monitoring

If prompted, allow both. You can also request the Accessibility prompt in Settings.

Hotkey ⌨️

Default: ⇧⌘C

You can change it in Settings (5 preset options).

Safety notice ⚠️

  • The app is unsigned by default. For distribution, you’ll need code signing and notarization.
  • Model outputs are structured; the UI renders the diff locally.
  • App logs redact sensitive token/key patterns and rotate locally to limit retained log size.
  • Vibe‑coded warning: This project was built rapidly without a full security review. Expect bugs, edge cases, and potential security issues. Use at your own risk, especially with sensitive data.

Developer guide 🧑‍💻

Build & Release (GitHub Actions) 🧱

  • Pushing a tag vX.Y or vX.Y.Z builds correctIA-vX.Y.Z.zip and publishes it to GitHub Releases.
  • Pushing to main builds correctIA-last-dev.zip as an artifact.

Contributing 🤝

Issues and PRs are welcome. Please include a brief repro and expected behavior.

Project structure 🗂️

  • Sources/main.swift — app UI and logic
  • .github/workflows/build.yml — CI build + release
  • scripts/make_app.sh — local app packaging

License

See LICENSE for terms.

Contact: add a preferred email/website if you want it listed here.

About

macOS menu bar app for smart English corrections with inline highlights and clear explanations.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors