How to install kneecap on Android using a 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.

   Copy the command for step 1

   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 kneecap

1. 3

   Open Terminal

   Keep it open beside this page.

   You know this worked when: Terminal is open

2. 4

   Check Git and Node

   Git and the current Node LTS are required.

   Type this into Terminal, then press Return.

   Copy the command for step 4

   git --version
   node --version

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

3. 5

   Install Bun

   kneecap's workspace is built with Bun. This installs it through npm.

   Type this into Terminal, then press Return.

   Copy the command for step 5

   mkdir -p "$HOME/.npm-global/bin"
   npm install -g --prefix "$HOME/.npm-global" bun
   grep -qsxF 'export PATH="$HOME/.npm-global/bin:$PATH"' "$HOME/.zshrc" || echo 'export PATH="$HOME/.npm-global/bin:$PATH"' >> "$HOME/.zshrc"
   export PATH="$HOME/.npm-global/bin:$PATH"

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

4. 6

   Copy kneecap 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.

   Copy the command for step 6

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

   You know this worked when: A kneecap folder appears

5. 7

   Open the kneecap 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.

   Copy the command for step 7

   cd ~
   cd kneecap

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

6. 8

   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.

   Copy the command for step 8

   cd ~/kneecap
   (
   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/kneecap"; then
     echo "~/kneecap 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 "~/kneecap 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 4f0ee2eeeeb867f3ddc9683d482b7c706c0cac14
   )

   You know this worked when: Git reports the reviewed commit

7. 9

   Install the workspace

   A few minutes the first time — it is a Rust and TypeScript monorepo.

   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.

   Copy the command for step 9

   cd ~/kneecap
   bun install

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

8. 10

   Build the editor

   Bundles the editor into apps/mobile/www — the assets the phone app loads offline.

   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.

   Copy the command for step 10

   cd ~/kneecap
   cd apps/mobile
   bun run build

   You know this worked when: Vite reports the build finished

9. 11

   Install Android Studio

   It brings the Android tools and Java with it. Open it once and let setup finish.

   Open download ↗

   You know this worked when: Android Studio opens to its welcome screen

10. 12

    Copy the editor into the Android 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.

    Copy the command for step 12

    cd ~/kneecap/apps/mobile
    bunx cap sync android

    You know this worked when: Capacitor reports the sync finished

11. 13

    Open the android folder in it

    Choose Open, then the android folder inside kneecap/apps/mobile. Let it sync.

    You know this worked when: Android Studio finishes syncing without an error

12. 14

    Turn on USB debugging

    Settings, About phone, tap Build number 7 times. Then Developer options, USB debugging.

    You know this worked when: USB debugging is switched on

13. 15

    Press Run

    Connect by USB, accept the phone's prompt, pick it in the menu, then Run.

    You know this worked when: kneecap appears in your app list

14. 16

    Check that it works

    Open kneecap, start a project, add a clip from your gallery, then Export.

    You know this worked when: The exported video saves back to your gallery

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.