What you end up with
kneecap running on your Android. It is free, and it stays free — there is no account, no trial and no subscription at the end of this.
- Time
- About 40 minutes
- Steps
- 16
- Cost
- Free
Before you start
These are one-time installs. If you have used PowerShell before, you may have them already — the first step checks.
Install Git
Run the installer, then reopen PowerShell.
Open installerYou know this worked when: Git responds with a version number
Install Node LTS
Run the LTS installer, then reopen PowerShell.
Open downloadYou know this worked when: Node responds with a version number
Install kneecap
Open PowerShell
Keep it open beside this page.
You know this worked when: PowerShell is open
Check Git and Node
Git and the current Node LTS are required.
Type this into PowerShell, then press Enter.
git --version node --versionYou know this worked when: Git and Node respond with version numbers
Install Bun
kneecap's workspace is built with Bun. This installs it through npm.
Type this into PowerShell, then press Enter.
npm.cmd install -g bunYou know this worked when: Bun responds with a version number
Copy kneecap to this PC
Type this into PowerShell, then press Enter.
cd ~ if [ ! -d kneecap/.git ]; then git clone https://github.com/Blueturboguy07/kneecap.git fiYou know this worked when: A kneecap folder appears
Open the kneecap folder
Type this into PowerShell, then press Enter.
cd kneecapYou know this worked when: Your terminal prompt is inside the kneecap folder
Use the reviewed version
Type this into PowerShell, then press Enter.
git checkout fc48ba487a1e0d0cd10b30d6600acd2895ffdbedYou know this worked when: Git reports the reviewed commit
Install the workspace
A few minutes the first time — it is a Rust and TypeScript monorepo.
Type this into PowerShell, then press Enter.
bun.cmd installYou know this worked when: The command finishes without an error
Build the editor
Bundles the editor into apps/mobile/www — the assets the phone app loads offline.
Type this into PowerShell, then press Enter.
cd apps/mobile bun.cmd run buildYou know this worked when: Vite reports the build finished
Install Android Studio
It brings the Android tools and Java with it. Open it once and let setup finish.
Open downloadYou know this worked when: Android Studio opens to its welcome screen
Copy the editor into the Android app
Type this into PowerShell, then press Enter.
bunx.cmd cap sync androidYou know this worked when: Capacitor reports the sync finished
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
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
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
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.