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
cd myapp
whitehall run

This creates a new project and launches it on your connected Android device.

Verify Installation

whitehall doctor

This checks that all dependencies (Java, Gradle, Android SDK) are properly configured.

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: