Guides › LanguageTool

Your own LanguageTool checker

LanguageTool, the checker Novelar uses, is open source: you can run it on your own computer. The paragraphs checked as you write then never leave your machine, and the checker works offline.

Before you start

1. Install and start the server

With Docker Desktop (Mac and Windows) or Docker (Linux) running, one command in a terminal:

docker run -d --name languagetool --restart unless-stopped -p 127.0.0.1:8010:8010 -e Java_Xmx=1g erikvl87/languagetool

It uses the community image erikvl87/languagetool, the most widely used one. 127.0.0.1 means only your computer can connect, and --restart unless-stopped starts it again whenever Docker opens.

Server address: http://localhost:8010

To check it's running, open the server address followed by /v2/languages in your browser (for example, http://localhost:8010/v2/languages). If you see a list of languages, it works. The first start can take a minute.

2. Connect it in Novelar

  1. Open Settings (⌘ , on a Mac, Ctrl , on Windows and Linux) and go to Services → Checker.
  2. Choose Your own server. The Server address is already filled in (http://localhost:8010); if you installed it with Homebrew, change it to http://localhost:8081.
  3. Press Test connection. It should say Connected.
  4. Press Use this one. From now on it shows as In use.

To try it, misspell a word, such as “recieve”: the underline now comes from your own computer.

If something doesn't work

To go back to the free service

In Settings → Services → Checker, choose Free LanguageTool and press Use this one. You can then stop the server (docker rm -f languagetool or brew services stop languagetool).

Want the AI review's text to stay on your computer too? Follow the LM Studio guide.