ZapbirdDocs

Install Zapbird

Install the command, the runner on your phone and the matching SDK.

You need three things: the zapbird command, the runner app on your phone, and the runner SDK that matches that runner.

#Install on Mac

Open Terminal and run the installer. It puts zapbird in ~/.zapbird/bin and on your PATH, or tells you how, then installs the runner SDK for this computer.

Terminal
$ curl -fsSL https://pub-8e7a72f4641f4f3691a843f412d19af4.r2.dev/cli/install.sh | sh$ zapbird --version

#Install on Windows

Open PowerShell and run the installer. It works on 64-bit Intel and AMD Windows. It puts zapbird in %USERPROFILE%\.zapbird\bin, adds that folder to your PATH, and then installs the runner SDK for this computer.

Terminal
$ irm https://pub-8e7a72f4641f4f3691a843f412d19af4.r2.dev/cli/install.ps1 | iex

Open a new PowerShell window afterwards, so the new PATH is picked up, and check the install with zapbird --version.

#The runner on your phone

Install Zapbird on your phone. In its Settings, turn on Trusted Flutter apps. The runner shows its build number there, which you need for the SDK.

#The SDK

The SDK is the set of files that match one build of the runner. One command installs the newest one for your computer.

Terminal
$ zapbird sdk install

When the runner on your phone updates, get the new SDK with one command. It does nothing if you already have the newest:

Terminal
$ zapbird sdk upgrade

To see what is published, or to pick the SDK of one runner build:

Terminal
$ zapbird sdk available$ zapbird sdk install --build <runner build>

You can also install an archive you were given, or download one from a link with its checksum:

Terminal
$ zapbird sdk install zapbird-sdk-0.3.0-abc123abc123.tar.gz$ zapbird sdk install https://host/zapbird-sdk-0.3.0-abc123abc123.tar.gz --sha256 <checksum>

Check what is installed with zapbird versions. With several builds installed, choose one with zapbird start --sdk <runner build>.

#Your app

  1. Run flutter pub get in your app folder.
  2. Run zapbird doctor to see what is ready and what is not.
  3. Run zapbird doctor --fix to match package versions to the runner.
  4. Run zapbird start and scan the QR code.

SDKs live in ~/.zapbird/sdk. Set ZAPBIRD_HOME to keep them somewhere else.

Was this doc helpful?

Zapbird sends no analytics. Read about security.

Flutter and the related logo are trademarks of Google LLC. Zapbird is not endorsed by or affiliated with Google LLC.

esc