Documentation

Installation

Get started with Whitehall in under a minute.

Quick Install

Run this command to install Whitehall:

curl -fsSL https://whitehall.sh/install | bash

Create Your First App

whitehall init myapp --app
cd myapp
whitehall dev

This creates a new app and starts the edit loop on your connected Android device: save a file, see the change. Without --app, init asks whether you want an app or a tool.

Verify Installation

whitehall doctor

This reports what the machine has — the Android SDK and adb, the NDK, Java and Gradle, and every connected device — and what to type next. It downloads nothing; the toolchain fetches what it needs the first time a build asks for it.

Whitehall automatically manages toolchains. No need to install Java or Gradle manually.

Requirements

  • macOS, Linux, or WSL
  • Android device or emulator
  • curl and tar (pre-installed on most systems)

Next Steps

Now that you're set up: