Spell Sync

Keep personal spelling words in one place — and sync them between your apps.

You teach a browser or editor a personal word — then another app underlines it again. Spell Sync keeps those words in one private list on your computer and copies them into supported apps' custom dictionaries.

Collect my words:   your apps → your word list
Update my apps:     your word list → your apps

• You always see a preview and confirm before anything changes.
• Collect never removes words from your personal list.
• Update may remove custom words that are no longer in your list.
• Built-in dictionaries are never changed.

Is this for you?

Yes, if:

• The same name, product term, or abbreviation is “wrong” in one app and fine in another
• You are willing to open a terminal for about five minutes of first setup
• You use at least one supported app (Chrome, Firefox, editors, macOS Spelling, JetBrains, Obsidian, and more — see Supported apps)

Not for you if:

• You want a click-install GUI with no terminal
• You need Spell Sync to invent or replace a built-in system/app dictionary
• You expect automatic sync over the internet (multi-computer sync is optional: synced folder or private Git — see Personal Workspace)

Start here

Primary path: follow Getting Started — install → open a folder → Start here → Review and update.

That guided flow is the product. The command table below is only for people who already prefer the shell.

Install

You need Python 3.14 and a terminal.

# install uv if you do not have it: https://docs.astral.sh/uv/
uv tool install git+https://github.com/arthurakbarov/spell-sync
uv tool update-shell   # if `spell-sync` is not on PATH yet
spell-sync

Or with pip (user install into a supported Python 3.14 — not Homebrew pip install -e):

python3.14 -m pip install --user \
  "spell-sync @ git+https://github.com/arthurakbarov/spell-sync"
# then ensure your user scripts directory is on PATH
spell-sync

If the command is missing or prints bad interpreter, see Troubleshooting and bad interpreter.

First run

mkdir ~/my-words && cd ~/my-words
spell-sync

Then: Start here → choose a folder → pick apps → Create project → on the dashboard open Review and update. Confirm each preview.

First-run defaults turn on common apps when they are found on your machine. Change them later under Targets. Real-application validation is still growing — see Supported apps.

Commands

Guest-facing names first; CLI verbs in parentheses:

Goal	Command
Interactive TUI	spell-sync
Non-interactive setup	spell-sync init
Collect my words (Pull)	spell-sync pull
Check my apps (Status)	spell-sync status
Preview Update my apps (Plan)	spell-sync plan
Update my apps (Push)	spell-sync push
Finish interrupted update	spell-sync recover
Check health	spell-sync doctor
Save word list to Git (optional)	spell-sync git-save / spell-sync git-save --push
Privacy-safe support bundle	spell-sync support-report

Docs

Doc	Purpose
Getting Started	Step-by-step first run
Supported apps	What Spell Sync can sync
Configuration	spell-sync.toml
Recovery	Interrupted updates
Troubleshooting	Common failures

License

Unlicense — public domain dedication.