How to install Hickeyfield on Mac

Before you start

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

1. 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. 2

   Install Node LTS

   Choose the macOS Installer (.pkg).

   Open download ↗

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

Install Hickeyfield

1. 3

   Open Terminal

   Keep it open beside this page.

   You know this worked when: Terminal is open

2. 4

   Check Git and Node

   Use Terminal. 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. 5

   Install pnpm

   The interface is a pnpm project.

   Type this into Terminal, then press Return.

   npm install -g pnpm

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

4. 6

   Install Rust

   Already have cargo? This step is already done. Otherwise rustup.rs shows one command to paste.

   Open rustup ↗

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

5. 7

   Copy Hickeyfield to this Mac

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

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

   You know this worked when: A hickeyfield folder appears

6. 8

   Open the hickeyfield folder

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   cd ~
   cd hickeyfield

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

7. 9

   Use the reviewed version

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   cd ~/hickeyfield
   (
   if ! git config --get remote.origin.url 2>/dev/null | sed -E 's#^git@github\.com:#https://github.com/#; s#\.git$##' | grep -qxF "https://github.com/Blueturboguy07/hickeyfield"; then
     echo "~/hickeyfield already exists and is not a clean copy of this app's source. Move or rename that folder, then press Try again."
     exit 1
   fi
   if git status --porcelain 2>/dev/null | grep -q .; then
     echo "~/hickeyfield already exists and is not a clean copy of this app's source. Move or rename that folder, then press Try again."
     exit 1
   fi
   git checkout ab5992c5aac8be595ce570e7ca0a80484e372321
   )

   You know this worked when: Git reports the reviewed commit

8. 10

   Install the interface packages

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   cd ~/hickeyfield
   cd ui
   pnpm install
   cd ..

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

9. 11

   Fetch the video engine

   About 80 MB. The script checks its licence before installing it.

   Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

   cd ~/hickeyfield
   ./scripts/fetch-ffmpeg.sh

   You know this worked when: It reports GPL, not nonfree, and finishes

10. 12

    Build the app

    The first build compiles the whole Rust core, so give it a while.

    Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

    cd ~/hickeyfield
    ui/node_modules/.bin/tauri build --bundles app

    You know this worked when: A Hickeyfield.app appears in the bundle folder

11. 13

    Put Hickeyfield in Applications

    Copy the freshly built app into Applications so it's a real, launchable Mac app.

    Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

    cd ~/hickeyfield
    ditto target/release/bundle/macos/Hickeyfield.app /Applications/Hickeyfield.app

    You know this worked when: Hickeyfield.app is in your Applications folder

12. 14

    Open Hickeyfield

    Built on your own machine, so macOS opens it without any warning.

    Type this into Terminal, then press Return. The first line moves you into the folder this step runs in, so it works in a window you have just opened.

    cd ~/hickeyfield
    open /Applications/Hickeyfield.app

    You know this worked when: Hickeyfield opens

13. 15

    Get a fal key

    Sign in, make a key, and copy it. You pay fal directly for what you generate.

    Open fal keys ↗

    You know this worked when: You have a key on your clipboard

14. 16

    Paste the key into Hickeyfield

    Settings, then fal, then Test. It is stored in your keychain, never in a file.

    You know this worked when: Hickeyfield reports the key works

15. 17

    Make something

    Type a shot, check the price on the button, and press Generate.

    You know this worked when: A video appears in the middle column and plays

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.