Skip to main content
HyperWhisper can sync your custom vocabulary to iCloud. The same words, names, and replacements are then available on every Mac and iPhone that is signed in to your Apple account. Only your vocabulary list goes to iCloud. Transcripts, recordings, and other settings stay on each device. Cloud sync is off by default. You enable it on each device.

​
Enable iCloud Sync

1

Open Settings

Click the HyperWhisper menu bar icon. Then choose Settings.
2

Go to the Vocabulary section

Select Vocabulary in the Settings sidebar.
3

Turn on iCloud Sync

Enable the iCloud Sync toggle. HyperWhisper shows an alert with the title Quit HyperWhisper to apply. The alert has a Quit HyperWhisper button and a Later button. The change takes effect the next time that you open the app. The app does not relaunch automatically.
Do these steps again on every device that you want to keep in sync.
You must enable the toggle on each device. When you enable it on your Mac, the toggle stays off on your iPhone. The opposite is also true.

​
How Sync Works

After you enable the toggle, HyperWhisper keeps your vocabulary in a CloudKit container (iCloud.com.hyperwhisper.hyperwhisper). This container uses NSPersistentCloudKitContainer. CloudKit from Apple sends your changes to your other devices in the background.
  • What syncs: Your custom vocabulary entries — the phrase, the replacement text, and the sort order.
  • What does not sync: Transcripts, recordings, modes, and all other settings. These stay on each device.
  • When sync happens: When the device has an internet connection and your iCloud account is active, a change on one device goes to your other devices.

​
Offline Behavior

You can add, edit, and delete vocabulary entries when the device is offline. HyperWhisper keeps the changes on the device. It sends them to iCloud when a connection is available again. If you add the same word on two devices when both are offline, CloudKit delivers both records after the devices connect again. HyperWhisper finds the duplicate and removes it. It keeps one copy of the word and deletes the extra record. On macOS, this duplicate removal runs the first time that you open the Vocabulary view in a session. Open that view once after the device connects again to start the cleanup.

​
Turn Off iCloud Sync

Disable the iCloud Sync toggle in the same place in Settings. After you open the app again, the app uses a local store only. Your vocabulary stays on the device. HyperWhisper no longer updates it from iCloud and no longer sends it to iCloud.

​
Troubleshooting

The vocabulary does not appear on another device.
  • Make sure that iCloud Sync is enabled on both devices (see Enable iCloud Sync above).
  • Make sure that both devices are signed in to the same Apple ID. Make sure that iCloud is enabled in System Settings (macOS) or Settings → [your name] (iOS).
  • Wait one or two minutes after you open the app again. The first sync can be slow on a new installation.
Duplicate entries appear after a sync. This occurs when you add the same word on two devices when both are offline. On macOS, HyperWhisper removes the extra entries the first time that you open the Vocabulary view in a session. Open that view once after the device connects again. If duplicates remain, delete one entry manually from the Vocabulary list. iCloud Sync is enabled, but the app uses local storage. If your iCloud account is signed out or not configured, HyperWhisper loads your vocabulary from the local store and does not show an error. Nothing breaks. Sync starts after you configure iCloud. A true CloudKit initialization failure is different. One example is a damaged local store. HyperWhisper treats this failure as fatal. It does not use local storage instead. If HyperWhisper does not launch after you enable iCloud Sync, make sure that iCloud is signed in and has free storage. Then open the app again.