How to install WimprFlow on Mac

WimprFlow does what WisprFlow does, and WisprFlow costs . This guide gets you the free one.

What you end up with

WimprFlow installed like any other app on your Mac. It is free, and it stays free — there is no account, no trial and no subscription at the end of this.

Time
About 23 minutes
Steps
14
Cost
Free

Before you start

These are one-time installs. If you have used Terminal before, you may have them already — the first step checks.

  1. Install Git

    Apple opens a small installer.

    Type this into Terminal, then press Return.

    xcode-select --install

    You know this worked when: Git responds with a version number

  2. Install Node LTS

    Choose the macOS Installer (.pkg).

    Open download

    You know this worked when: Node responds with a version number

Install WimprFlow

  1. Open Terminal

    Keep it open beside this page.

    You know this worked when: Terminal is open

  2. Check Git and Node

    Git and the current Node LTS are required.

    Type this into Terminal, then press Return.

    git --version
    node --version

    You know this worked when: Git and Node respond with version numbers

  3. Install Rust

    Run the single command the page shows, then reopen Terminal.

    Open rustup

    You know this worked when: cargo responds with a version number

  4. Copy WimprFlow to this Mac

    Type this into Terminal, then press Return.

    cd ~
    if [ ! -d WhimprFlow/.git ]; then
    git clone https://github.com/chrisznb/WhimprFlow.git
    fi

    You know this worked when: A WhimprFlow folder appears

  5. Open the WimprFlow folder

    Type this into Terminal, then press Return.

    cd WhimprFlow

    You know this worked when: Your terminal prompt is inside the WhimprFlow folder

  6. Use the reviewed version

    Type this into Terminal, then press Return.

    git checkout 5e99a6c9ce26adb51b167b7e21dd6e5f1f4e7410

    You know this worked when: Git reports the reviewed commit

  7. Install dependencies

    Type this into Terminal, then press Return.

    cargo fetch

    You know this worked when: The command finishes without an error

  8. Try WimprFlow

    Keep Terminal open.

    Type this into Terminal, then press Return.

    cargo run

    You know this worked when: WimprFlow opens

  9. Allow Microphone

    In Privacy & Security, turn on Microphone for WimprFlow.

    You know this worked when: Microphone is turned on

  10. Allow Accessibility

    In Privacy & Security, turn on Accessibility for WimprFlow.

    You know this worked when: Accessibility is turned on

  11. Allow Notifications

    In Privacy & Security, turn on Notifications for WimprFlow.

    You know this worked when: Notifications is turned on

  12. Try it

    WimprFlow should be open and ready to use.

    You know this worked when: WimprFlow works

If something goes wrong

Nothing here can damage your computer, and every step can be run again safely. If a command fails, the usual cause is the step before it not having finished.

Still stuck? Tell us what happened and we will fix the guide. Include the step number and we can usually reproduce it.

Have a different setup?