Files
faceclaw/docs/development-nix.md
T

1.5 KiB

Nix development environment

Install Nix with flakes and devenv, then run devenv shell in this directory (or nix run nixpkgs#devenv -- shell). With direnv, direnv allow loads .envrc. The committed devenv.lock pins the environment inputs.

The environment provides Node 22/npm, Java 21, Android SDK/platform 35, build-tools 35.0.0/35.0.1 (app and NativeScript plugins), NDK 27, CMake, Git/GitHub CLI, Python and build utilities. Android SDK licenses are accepted through devenv.yaml. Gradle uses the Nix-patched SDK aapt2. Gradle itself comes from the repository's wrapper. The emulator and system images are omitted. NS_SKIP_ENV_CHECK=1 bypasses NativeScript doctor's mandatory emulator check; devenv test checks the actual SDK/JDK build prerequisites instead.

Run faceclaw-setup (npm ci) once, then faceclaw-test (npm test), npm run lint and npm run test:kotlin. devenv test checks the environment. bash build.sh builds the Android app; it does not install it. On NixOS, any additional downloaded native executables may require the host's nix-ld support. iOS builds still require macOS/Xcode and are outside this Linux environment.

Keep machine-specific signing/device settings in the ignored build_paths.sh. Use gh auth login separately if GitHub CLI is not already authenticated.

Software tests do not validate Bluetooth behavior on physical glasses. Record device/firmware versions and manual results separately for hardware checks. Do not flash firmware during development without explicit permission.