Docs

Install the app

Build the APK and put it on your phone.

1. Build the APK

You need JDK 17 and the Android SDK (platform 37). The repository ships a script that points the build at them.

bash
source scripts/android-env.sh      # sets JAVA_HOME and ANDROID_HOME (defaults: ~/tools/jdk-17, ~/Android)
just android-build                 # -> android/app/build/outputs/apk/debug/app-debug.apk

Or open the android/ folder in Android Studio.

2. Put it on the phone

The simplest. Copy app-debug.apk to the phone (a USB cable, a cloud drive, a message to yourself), open it, and allow installing from that source when Android asks.

3. First run

  1. Connect

    Scan the pairing QR code with the camera (pairing), or open the app and enter the address and token under Settings, Connection. Test connection tells you if it works.

  2. Tap the orb and allow the microphone

    Speak. Avni sends what you said when you stop talking, and answers out loud. Tapping the orb while it answers interrupts it.

  3. Allow notifications

    Android asks the first time a session starts. The notification is how Avni shows it is listening in the background, and it has a Stop button.

  4. Run the setup check

    After you pair, Avni opens Settings, Setup check if anything is left. It lists your server, the microphone, notifications, background running (for hands-free) and contacts, each with one button. Phones from some makers stop background apps unless you allow it, so do that one if you use Until I stop.

What you can change

WhereWhat
Settings, Voice and listeningAutomatic or Tap to send. After a reply: Stop, 4 seconds, or Until I stop (hands-free: the mic and a notification stay up until you tap the orb or press Stop). Speaking speed, with a sample.
Settings, ModelsPick the speech and language model from what your server offers, and the reply style. A choice applies on the next connection. It lists nothing until the server has sent its list, so restart core after an upgrade.
Activity, UsageCalls and spend per provider, today and this month, against your cap.
Settings, PrivacyExactly what leaves the phone.