ZapbirdDocs

zapbird start

Serve your project to the runner on your phone.

Usage: zapbird start [options]

Run it inside your app folder, or pass --project. It prints a QR code and a link, which keep working for 24 hours while the server runs. With a runner SDK installed it starts the fast bytecode mode on its own. Without one it serves the full Flutter (kernel) mode.

Terminal
$ zapbird start$ zapbird start --project ../shop --qr-hours 4$ zapbird start --dart-define-from-file .env

#Options

OptionWhat it does
--project <folder>The app folder. Default: the current folder.
--host <ip>The network address of this computer. Default: found for you.
--port <number>Port 1024 to 65535. Default: 8443.
--runtime <name>bytecode (fast, needs an SDK), kernel (full Flutter), flutter or widgets (smaller previews).
--sdk <build>Choose an installed SDK by runner build or name.
--host-sdk <folder>Use this SDK folder instead of an installed one.
--flutter <path>The flutter command to use. Default: flutter on PATH.
--dart-define NAME=valueLike flutter run. Can be repeated.
--dart-define-from-file <file>A JSON or .env file of defines.
--qr-hours <1-24>How long the QR code and link work. Default: 24.
--single-use-qrThe QR code and link work only once.
--show-linkAlso print the long pairing link. It holds the QR secret, so it is hidden unless you ask.
--no-tailscaleDo not also serve on this computer's Tailscale address.
--verbosePrint every request the phone makes, with its status and time.
--allow-phone-editLet the phone edit the Dart files in lib/.
--allow-secretsSend a project that holds server-side keys. Not advised.
--session-seconds <1-900>How long a phone session lasts before it renews. Default: 900.

#While it runs

Type a key and press Enter: p for a new QR code, y or n to allow or refuse a phone that asks to connect. In bytecode mode every save updates the phone by itself. In kernel mode r is hot reload and R is restart.

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