Shorebird CLI is a command-line interface tool that aims to enhance developer productivity by automating repetitive tasks commonly encountered during software development. Developed with simplicity and flexibility in mind, Shorebird CLI provides a set of commands and utilities to facilitate various aspects of the development lifecycle, from project setup to deployment.
Welcome to Shorebird 👋
Please follow the steps below to get started with Shorebird 🚀
1. Install the Shorebird CLI 📦
MacOS/Linux
Open a terminal and run:
curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash
Windows
Open PowerShell and run:
Set-ExecutionPolicy RemoteSigned -scope CurrentUser # Needed to execute remote scripts
iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1'|iex
2. Login 🔐
shorebird login
3. Initialize Shorebird in your Flutter project 🐦
shorebird init
4. Create a release 🚀
shorebird release android
5. Install the release ⬇️
Install the generated release onto a device via one of the following steps:
a. Install the generated apk on a device/emulator
b. Upload the generated aab to the Play Store
c. Use shorebird preview to run the release on a connected device/emulator.
6. Change some Dart code 🎯
7. Create a patch 🧩
shorebird patch android
8. Install the patch ⬇️
On the device/emulator:
Re-launch the app once to download the patch.
Re-launch the app again to boot from the patch.