Skip to main content

How to build?

To build Local Desktop from source code, you can follow these steps:

  1. Make sure git lfs is installed. You can install it by following the official instructions.

  2. Clone the source code repository:

    git clone https://github.com/localdesktop/localdesktop.git

  3. Make sure you already have Rust and Cargo installed. If not, please check the official Rust website for installation instructions. Then, you can install the xbuild tool:

    cargo install xbuild

    At the moment, you need to install a locally patched version of xbuild. Follow this instruction instead:

    cd patches/xbuild
    cargo install --path xbuild

  4. Build the project:

    x build --platform android --arch arm64

Then you will find the APK file in target/x/debug/android/localdesktop.apk.

FAQ​

Can I build on Termux?​

No. xbuild requires rustup, which, at the time of writing, is not available on Termux.

Can I build on Termux & proot-distro?​

Yes.