Skip to content

About

Offline autocorrect and word prediction for Persian and English in every Windows app. اصلاح خودکار و پیشنهاد کلمه فارسی و انگلیسی برای ویندوز

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

TypeAssist icon

TypeAssist

Autocorrect and word prediction for Persian and English, in every Windows app.
100% offline · no installer · nothing leaves your PC

Latest release CI MIT license Windows 10 | 11

فارسی


TypeAssist sits in the system tray and fixes typos as you type, in your browser, Word, Telegram, Notepad, anywhere. It also shows a small suggestion bar next to the caret, so you can finish words with one key. It handles both Persian and English and switches automatically with your keyboard layout.

وجدود ␣   →  وجود ␣
میخواهم ␣  →  می‌خواهم ␣      (adds the missing half-space / ZWNJ)
teh ␣     →  the ␣

🔒 Fully local and offline

  • No internet connection, ever. The code contains no networking at all. Nothing you type is sent anywhere.
  • No full text is saved. Only single words and word pairs with a count are kept, to personalise suggestions.
  • Your data stays in %AppData%\TypeAssist on your own PC, and you can wipe it from the tray menu at any time.
  • Password fields are ignored. Nothing is corrected or learned there.
  • No installer and no admin rights. It's a single .exe.
  • Open source. Read the code, or build the exe yourself with build.bat.

More detail in SECURITY.md.

Download and run

  1. Download TypeAssist-1.3.0.zip from the latest release and extract it (for example to C:\Tools\TypeAssist).
  2. Run TypeAssist.exe. It needs .NET Framework 4.8, which Windows 10 and 11 already include.
  3. Windows SmartScreen warning: because the exe isn't digitally signed, Windows may show "Windows protected your PC". Click More info → Run anyway. This is normal for small unsigned open-source apps, not a sign of a problem.
  4. A green Aa icon appears next to the clock. It's grey for the first few seconds while the dictionary loads.
  5. To start it with Windows: right-click the icon → Start with Windows.

Some antivirus products are suspicious of any app that reads the keyboard, because keyloggers do that too. TypeAssist only reads keys to correct them and has no way to send anything out. If in doubt, build it from source (see below).

How to use

Action Key
Autocorrect Happens after Space, Enter or punctuation (. , ? ! and their Persian forms)
Undo a correction Press Backspace right away. Your word comes back and is never corrected again
Accept the first (highlighted) suggestion Tab
Accept suggestion 1 / 2 / 3 Alt+1 / Alt+2 / Alt+3, or click it
Close the suggestion bar Esc
Turn TypeAssist on/off Ctrl+Alt+F12, or left-click the tray icon

When you accept a suggestion, a space is added for you. If you then type . or ,, that extra space is removed.

Why it doesn't get in the way

  • It only corrects when it's nearly certain. If two words are likely (e.g. «ضرف»: ظرف or صرف?) it only suggests.
  • Finglish (salam, chetori, merci…), capitalised names mid-sentence, ALL-CAPS words (NASA), words with digits, and parts of URLs, emails and file paths are left alone.
  • Valid inflected forms (کتابش، می‌ترکند، نخریدن, plurals, -ed, -ing…) aren't treated as typos.
  • The first word after a click is corrected only if it has at least 4 letters and the fix is obvious, since TypeAssist hasn't seen the letters before it.
  • It's switched off in terminals, code editors (VS Code, Visual Studio, JetBrains, Notepad++…), remote desktop, password managers and full-screen games.
  • You can exclude any other app from the tray menu → Pause in this app (excludes the app you last typed in; click again to undo).

Learning

TypeAssist learns words you type often and the order you use them in, so suggestions get more personal over time. An unknown word you type 3 times is never corrected again. You can turn learning off or clear everything it has learned from the tray menu.

Settings

Tray menu → Open settings folder, edit settings.ini, then Reload settings.

Key Meaning
autocorrect, suggestions, learn yes / no
zwnj_fix Add the half-space in می‌/نمی‌ and ها/های
accept_with_tab Set to no if you need Tab for something else (Alt+1..3 still work)
smart_space Add a space after accepting a suggestion
popup_delay_ms Delay before the suggestion bar appears (default 60)
excluded_apps Process names without .exe, comma-separated

Known limitations

  • Apps run as administrator aren't covered unless TypeAssist also runs as administrator.
  • Some apps (certain Electron and Java apps) don't report the caret position, so the bar appears next to the mouse pointer instead.
  • Persian suggestions start out based mostly on formal text (Wikipedia) and get better as you type.

Build from source

Nothing to install. The build uses the C# compiler that ships with Windows.

build.bat              :: produces TypeAssist.exe next to it
tests\run_tests.bat    :: builds and runs the test suite

Rebuilding the language data is optional. See tools/build_data.py.

Project layout

src/Engine/   correction and prediction engine (no Windows dependencies)
src/Win/      keyboard hook, tray app, suggestion popup, settings
data/         compressed word lists and word-pair frequencies (embedded into the exe)
tests/        engine and input-tracker tests
tools/        script that generates data/

Contributing

Issues and pull requests are welcome. See CONTRIBUTING.md.

License

Code: MIT © 2026 MH.Kovich. Language data comes from wordfreq, codespell, NLTK and Persian-NER under their own licenses. See THIRD_PARTY_NOTICES.md.

About

Offline autocorrect and word prediction for Persian and English in every Windows app. اصلاح خودکار و پیشنهاد کلمه فارسی و انگلیسی برای ویندوز

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages