Shorebird

https://docs.shorebird.dev
Admin
Shorebird is an over-the-air update platform for Flutter apps that enables developers to deploy...
Tokens:58,096
Snippets:809
Trust Score:8.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Verify patch installation logs

Source: https://docs.shorebird.dev/code-push/guides/hybrid-apps/ios

Example of the logs displayed in the console when a patch is successfully checked and installed.

```text
Sending patch check request: PatchCheckRequest { app_id: "db32f785-284a-429b-9348-d3ead3485438", channel: "stable", release_version: "1.2.3+4", patch_number: None, platform: "ios", arch: "aarch64" }

/// other logs

Patch 1 successfully installed.
```

--------------------------------

### Shorebird initialization output example

Source: https://docs.shorebird.dev/code-push/initialize

Example output showing the successful initialization of a project named shorebird_test.

```text
$ shorebird init
✓ Detecting product flavors (0.6s)
? How should we refer to this app? (shorebird_test) shorebird_test
✓ Shorebird is up-to-date (0.6s)
✓ Flutter install is correct (4.5s)
✓ AndroidManifest.xml files contain INTERNET permission (23ms)

No issues detected!

🐦 Shorebird initialized successfully!

✅ A shorebird app has been created.
✅ A "shorebird.yaml" has been created.
✅ The "pubspec.yaml" has been updated to include "shorebird.yaml" as an asset.

Reference the following commands to get started:

📦 To create a new release use: "shorebird release".
🚀 To push an update use: "shorebird patch".
👀 To preview a release use: "shorebird preview".

For more information about Shorebird, visit https://shorebird.dev
```

--------------------------------

### Install Flutter SDK via Homebrew

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

Use Homebrew to automatically handle architecture-specific installation paths.

```bash
brew install --cask flutter
```

--------------------------------

### Install Shorebird via AI Prompt

Source: https://docs.shorebird.dev/getting-started

Use this prompt with an AI assistant to receive guided installation instructions.

```text
Install Shorebird on my machine. Shorebird is a Flutter code push tool.

Mac/Linux:
curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash

Windows:
Set-ExecutionPolicy RemoteSigned -scope CurrentUser
iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex

After installing, run `shorebird doctor` to verify and help me fix any issues.
```

--------------------------------

### Manual Shorebird Installation

Source: https://docs.shorebird.dev/getting-started

Clone the repository directly to perform a manual installation.

```bash
git clone -b stable https://github.com/shorebirdtech/shorebird.git
```

--------------------------------

### Install Flutter via Snap

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

The recommended method for installing Flutter on Linux using the snap package manager.

```bash
sudo snap install flutter --classic
```

--------------------------------

### Install CocoaPods

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

Install CocoaPods via Homebrew or Ruby gems.

```bash
brew install cocoapods
```

```bash
brew install ruby
echo 'export PATH="/opt/homebrew/opt/ruby/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
gem install cocoapods
```

--------------------------------

### Install Git on Ubuntu

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

Command to install the Git version control system on Ubuntu Linux distributions.

```bash
sudo apt-get install git
```

--------------------------------

### Install Xcode Toolchain

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

Commands to configure the Xcode command line tools and accept the license.

```bash
xcode-select --install
sudo sh -c 'xcode-select -s /Applications/Xcode.app/Contents/Developer && xcodebuild -runFirstLaunch'
sudo xcodebuild -license accept
xcodebuild -downloadPlatform iOS
```

--------------------------------

### Verify Git Installation

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

Check the installed version of Git to ensure the prerequisite is met before proceeding with the Flutter installation.

```bash
git --version
```

--------------------------------

### Example shorebird.yaml configuration

Source: https://docs.shorebird.dev/code-push/guides/flavors/ios

The resulting configuration file after adding a new flavor.

```yaml
app_id: ee322dc4-3dc2-4324-90a9-04c40a62ae76
flavors:
  internal: ee322dc4-3dc2-4324-90a9-04c40a62ae76
  stable: 904bd3d5-3526-4c1c-a832-7ac23c95302d
+ beta: a41f8226-4b46-45d6-9e19-b14d0cf17bdc
```

--------------------------------

### Patch Command Output Example

Source: https://docs.shorebird.dev/code-push/patch

Example of the console output generated when running a patch command.

```text
$ shorebird patch android
✓ Building patch (3.0s)
✓ Fetching apps (0.2s)
✓ Detecting release version (0.3s)
✓ Fetching release (77ms)
✓ Fetching Flutter revision (15ms)
✓ Fetching release artifacts (0.3s)
✓ Downloading release artifacts (1.9s)
✓ Creating artifacts (4.1s)

🚀 Ready to publish a new patch!

📱 App: My App (61fc9c16)
📦 Release Version: 0.1.0+1
📺 Channel: stable
🕹️  Platform: android [arm64 (166.20 KB), arm32 (161.78 KB), x86_64 (161.51 KB)]

Would you like to continue? (y/N) Yes
✓ Creating patch (93ms)
✓ Uploading artifacts (1.5s)
✓ Fetching channels (86ms)
✓ Promoting patch to stable (78ms)

✅ Published Patch!
```

--------------------------------

### Example shorebird.yaml with Flavors

Source: https://docs.shorebird.dev/code-push/guides/flavors/ios

The generated configuration file showing how app IDs are mapped to specific flavors.

```yaml
# This file is used to configure the Shorebird updater used by your application.
# Learn more at https://shorebird.dev
# This file should be checked into version control.

# This is the unique identifier assigned to your app.
# It is used by your app to request the correct patches from Shorebird servers.
app_id: ee322dc4-3dc2-4324-90a9-04c40a62ae76
flavors:
  internal: ee322dc4-3dc2-4324-90a9-04c40a62ae76
  stable: 904bd3d5-3526-4c1c-a832-7ac23c95302d
```

--------------------------------

### Install Linux Desktop Development Dependencies

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

Install additional build tools and libraries required for developing desktop applications on Linux.

```bash
sudo apt-get install clang cmake git ninja-build pkg-config libgtk-3-dev liblzma-dev libstdc++-12-dev
```

--------------------------------

### Install Shorebird CLI

Source: https://docs.shorebird.dev/getting-started

Run the platform-specific script to install the Shorebird CLI and a bundled Flutter version.

```bash
curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash
```

```powershell
Set-ExecutionPolicy RemoteSigned -scope CurrentUser
iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex
```

--------------------------------

### Example shorebird.yaml configuration

Source: https://docs.shorebird.dev/code-push/guides/staging-patches

The configuration file generated after creating a Shorebird project, containing the app_id.

```yaml
# Your app_id is not a secret and is just used to identify your app
# when requesting patches from Shorebird's servers.
app_id: ee322dc4-3dc2-4324-90a9-04c40a62ae76
# auto_update controls if Shorebird should automatically update in the background on launch.
# If auto_update: false, you will need to use package:shorebird_code_push to trigger updates.
# https://pub.dev/packages/shorebird_code_push
# Uncomment the following line to disable automatic updates.
# auto_update: false
```

--------------------------------

### Install Linux Dependencies

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

Update system packages and install essential tools required for Flutter development on Ubuntu.

```bash
sudo apt-get update -y && sudo apt-get upgrade -y
sudo apt-get install -y curl git unzip xz-utils zip libglu1-mesa
```

--------------------------------

### Install Shorebird Fastlane Plugin

Source: https://docs.shorebird.dev/code-push/ci/fastlane

Run this command to install the plugin that provides shorebird_release and shorebird_patch actions.

```bash
bundle exec fastlane add_plugin shorebird
```

--------------------------------

### Install Shorebird CLI

Source: https://docs.shorebird.dev/code-push/ci/generic

Run this command on Linux or Mac build agents to install the Shorebird CLI.

```bash
curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash
```

--------------------------------

### Shorebird configuration file examples

Source: https://docs.shorebird.dev/code-push/initialize

Standard shorebird.yaml structure and the structure used when supporting multiple flavors.

```yaml
# This file is used to configure the Shorebird updater used by your application.
# Learn more at https://shorebird.dev
# This file should be checked into version control.

# This is the unique identifier assigned to your app.
# It is used by your app to request the correct patches from Shorebird servers.
app_id: 8c846e87-1461-4b09-8708-170d78331aca
```

```yaml
# This file is used to configure the Shorebird updater used by your application.
# Learn more at https://shorebird.dev
# This file should be checked into version control.

# This is the unique identifier assigned to your app.
# It is used by your app to request the correct patches from Shorebird servers.
app_id: 864ab1b0-ba78-4b15-990a-a63cec35a41b
flavors:
  development: 864ab1b0-ba78-4b15-990a-a63cec35a41b
  production: 6b6e6631-4fbe-4645-8d9d-d5247656d975
```

--------------------------------

### Patching with Flavors and Targets

Source: https://docs.shorebird.dev/code-push/patch

Specify build flavors and entry point targets for complex application setups.

```bash
shorebird patch android --target lib/main_development.dart --flavor development
```

--------------------------------

### Verify Shorebird Installation

Source: https://docs.shorebird.dev/getting-started

Run the doctor command to check for installation issues and verify connectivity.

```bash
shorebird doctor
```

```text
$ shorebird doctor
Shorebird 1.5.1 • git@github.com:shorebirdtech/shorebird.git
Flutter 3.27.0 • revision 1e0e5760eeaf534c280cf59ee0504d0e2ba12a7b
Engine • revision 59571a1190752bc1740bff652ce5f0ba7c9413f8

URL Reachability
✓ https://api.shorebird.dev OK (0.1s)
✓ https://console.shorebird.dev OK (0.1s)
✓ https://oauth2.googleapis.com OK (60ms)
✓ https://storage.googleapis.com OK (0.2s)
✓ https://cdn.shorebird.cloud OK (0.1s)

✓ Shorebird is up-to-date (1.4s)
✓ Flutter install is correct (0.4s)

No issues detected!
```

--------------------------------

### Install Shorebird CLI on Windows

Source: https://docs.shorebird.dev/flutter-concepts/flutter-for-beginners

Execute these commands in PowerShell to configure execution policies and install the Shorebird CLI on Windows.

```powershell
Set-ExecutionPolicy RemoteSigned -scope CurrentUser
iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1'|iex
```

--------------------------------

### Configure Shorebird in GitHub Actions

Source: https://docs.shorebird.dev/code-push/ci/github

Use the setup-shorebird action to install the CLI and enable subsequent Shorebird commands in your workflow.

```yaml
name: Shorebird Workflow Example

on:
  workflow_dispatch:

jobs:
  example:
    defaults:
      run:
        shell: bash

    runs-on: ubuntu-latest

    steps:
      # Use the setup-shorebird action to configure Shorebird
      - name: 🐦 Setup Shorebird
        uses: shorebirdtech/setup-shorebird@v1
        with:
          cache: true # Optionally cache your Shorebird installation

      # Now we're able to use Shorebird CLI in our workflow
      - name: 🚀 Use Shorebird
        run: shorebird --version
```

--------------------------------

### Shorebird Release with Arguments

Source: https://docs.shorebird.dev/code-push/ci/fastlane

Example of passing additional arguments to the shorebird_release action.

```ruby
shorebird_release(platform: "ios", args: "--no-codesign -- --build-name=1.0.0")
```

--------------------------------

### Preview Shorebird releases

Source: https://docs.shorebird.dev/flutter-concepts/flutter-for-beginners

Example output of the preview command used to test release artifacts on a connected device.

```text
➜  my_flutter_app shorebird preview
✓ Fetching releases (0.5s)
✓ Fetching releases (0.5s)
Which release would you like to preview? 1.0.0+1
✓ Fetching aab artifact (0.4s)
✓ Using stable track (0.7s)
✓ Extracting metadata (1.0s)
✓ Built apks: /Users/<username>/.shorebird/bin/cache/previews/dbad83ad-92fd-4228-af9a-014800f6efd7/android_1.0.0+1_1966896.apks (2.9s)
✓ Installing apks (6.0s)
✓ Starting app (1.8s)
```

--------------------------------

### Verify Patch Signature Logs

Source: https://docs.shorebird.dev/code-push/guides/patch-signing

Observe application logs during preview to confirm successful patch installation and signature verification.

```text
05-22 23:47:51.645  6963  6994 I flutter : updater::updater: Patch 1 successfully installed.
05-22 23:47:51.645  6963  6994 I flutter : updater::updater: Update thread finished with status: Update installed
```

```text
05-23 11:32:33.944  7029  7029 I flutter : updater::cache::signing: Verifying patch signature...
05-23 11:32:33.944  7029  7029 I flutter : updater::cache::signing: Patch signature is valid
```

--------------------------------

### Preview a release

Source: https://docs.shorebird.dev/code-push/preview

Basic command to download and run a release on a connected device.

```bash
shorebird preview
```

--------------------------------

### Shorebird Logcat Output

Source: https://docs.shorebird.dev/code-push/guides/hybrid-apps/android

Example log output showing the Shorebird updater checking for and installing a patch.

```text
[INFO:shorebird.cc(109)] Shorebird updater: no active patch.
[INFO:shorebird.cc(113)] Starting Shorebird update
updater::network: Sending patch check request: PatchCheckRequest { app_id: "baad0583-6810-44a7-9034-6aadb8127f29", channel: "stable", release_version: "1.0.0+8", patch_number: None, platform: "android", arch: "aarch64" }
updater::updater: Patch 1 successfully installed.
updater::updater: Update thread finished with status: Update installed
```

--------------------------------

### Create a release for platforms

Source: https://docs.shorebird.dev/code-push/guides/staging-patches

Commands to create a release for Android, iOS, or macOS.

```bash
shorebird release android
```

```bash
shorebird release ios
```

```bash
shorebird release macos
```

--------------------------------

### Configure shared Codemagic environment and scripts

Source: https://docs.shorebird.dev/code-push/ci/codemagic

Defines shared environment variables, Shorebird installation, keychain initialization, and code signing setup for iOS workflows.

```yaml
definitions:
  environment:
    shared_env: &shared_env
      flutter: 3.44.8
      groups:
        # Export the shorebird group to make $SHOREBIRD_TOKEN available to
        #   the Shorebird CLI.
        - shorebird
        # Export the app_store group to make the iOS code signing variables
        #   available the scripts below.
        - app_store
      vars:
        # The bundle ID of this example app.
        # Replace this with your app's bundle id.
        BUNDLE_ID: dev.shorebird.codemagic-demo
        FLUTTER_VERSION: 3.44.8
  scripts:
    # Download the Shorebird CLI and add it to the PATH.
    - &shorebird_install
      name: Install Shorebird
      script: |
        # Install Shorebird
        curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash

        # Add Shorebird to PATH
        echo PATH="$HOME/.shorebird/bin:$PATH" >> $CM_ENV
    - &ios_initialize_keychain
      # Set up the keychain to be used for code signing. Create the keychain
      #   at specified path with specified password with given timeout.
      # Make it default and unlock it for upcoming use.
      name:
        Set up keychain to be used for codesigning using Codemagic CLI
        'keychain' command
      script: |
        keychain initialize
    - &fetch_signing_files
      # Fetch provisioning profiles and code signing certificates for
      #   the Bundle ID with given identifier.
      name: Fetch signing files
      script: |
        app-store-connect fetch-signing-files "$BUNDLE_ID" \
          --type IOS_APP_STORE --create \
          --issuer-id "$ISSUER_ID" \
          --key-id "$KEY_ID" \
          --private-key="$APP_STORE_CONNECT_PRIVATE_KEY"
    - &add_certs_to_keychain
      name: Add certs to keychain
      script: |
        keychain add-certificates
    - &use_profiles
      # This generates an export_options.plist file that tells Xcode
      #   how to package the app. This explicitly sets
      #   manageAppVersionAndBuildNumber to control which
      #   version and build number are used for releasing and patching.
      name: Set up code signing settings on Xcode project
      script: |
        xcode-project use-profiles --custom-export-options={"manageAppVersionAndBuildNumber":false}
    - &fetch_dependencies
      name: Fetch Dependencies
      script: |
        flutter pub get
```

--------------------------------

### Preview Android release with keystore

Source: https://docs.shorebird.dev/code-push/preview

Command to preview an Android release signed with a specific production keystore.

```bash
shorebird preview \
  --platform android \
  --release-version 1.0.0+1 \
  --ks /path/to/keystore.jks \
  --ks-pass pass:my_keystore_password \
  --ks-key-alias my_key_alias
```

--------------------------------

### Create a new Flutter project

Source: https://docs.shorebird.dev/flutter-concepts/state-management/advanced

Commands to initialize a new Flutter application, with an optional variant for Shorebird support.

```bash
flutter create my_new_app
```

```bash
shorebird create my_new_app
```

--------------------------------

### Test a patch locally

Source: https://docs.shorebird.dev/code-push/preview

Sequence of commands to create a release, preview it, create a patch, and verify the patch on a device.

```bash
shorebird release [platform]
```

```bash
shorebird preview
```

```bash
shorebird patch [platform] --track=staging
```

```bash
shorebird preview --track=staging
```

--------------------------------

### Create a Windows release

Source: https://docs.shorebird.dev/code-push/release

Initiates the release process for a Windows application.

```bash
shorebird release windows
```

--------------------------------

### Create Android Release

Source: https://docs.shorebird.dev/code-push/guides/percentage-based-rollouts

Initializes a patchable Android release build.

```bash
shorebird release android
```

--------------------------------

### List all releases

Source: https://docs.shorebird.dev/code-push/release

Displays a list of all releases for the current app, including version, platform, and patch information.

```bash
shorebird releases list
```

--------------------------------

### Re-initialize Shorebird for Flavors

Source: https://docs.shorebird.dev/code-push/guides/flavors/ios

Run this command to re-initialize the project configuration after setting up flavors.

```bash
shorebird init --force
```

--------------------------------

### Apply code change

Source: https://docs.shorebird.dev/code-push/guides/stores/play-store

Example of the code modification in lib/main.dart.

```diff
     (clock) => clock.name == clockName,
-    orElse: () => ClockFace.generative,
+    orElse: () => ClockFace.particle,
   );
```

--------------------------------

### Shorebird Patch with Arguments

Source: https://docs.shorebird.dev/code-push/ci/fastlane

Example of passing additional arguments to the shorebird_patch action.

```ruby
shorebird_patch(platform: "ios", args: "--allow-native-diffs -- --build-name=1.0.0")
```

--------------------------------

### Preview a release locally

Source: https://docs.shorebird.dev/code-push/guides/staging-patches

Command to preview a specific release version on a local device or emulator.

```bash
# Preview the release in the staging environment
shorebird preview --track staging --app-id ee322dc4-3dc2-4324-90a9-04c40a62ae76 --release-version 1.0.0+1
```

--------------------------------

### Update Shorebird CLI

Source: https://docs.shorebird.dev/getting-started

Check for and apply updates to the local Shorebird CLI installation.

```bash
shorebird upgrade
```

--------------------------------

### Create Android releases for flavors

Source: https://docs.shorebird.dev/code-push/guides/flavors/android

Commands to create separate releases for different Android build flavors.

```bash
# Create a release for the internal flavor
shorebird release android --flavor internal

# Create a release for the stable flavor
shorebird release android --flavor stable
```

--------------------------------

### Update Flutter theme

Source: https://docs.shorebird.dev/flutter-concepts/flutter-for-beginners

Example code modification to trigger a patch update in a Flutter application.

```dart
theme: ThemeData(
  colorScheme: .fromSeed(seedColor: Colors.deepPurple),
),
```

--------------------------------

### Modify app theme for patch

Source: https://docs.shorebird.dev/code-push/guides/flavors/ios

Example code change in lib/main.dart to demonstrate patching functionality.

```dart
class MyApp extends StatelessWidget {
  const MyApp({super.key});

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        // This is the theme of your application.
        //
        // TRY THIS: Try running your application with "flutter run". You'll see
        // the application has a blue toolbar. Then, without quitting the app,
        // try changing the seedColor in the colorScheme below to Colors.green
        // and then invoke "hot reload" (save your changes or press the "hot
        // reload" button in a Flutter-supported IDE, or press "r" if you used
        // the command line to start the app).
        //
        // Notice that the counter didn't reset back to zero; the application
        // state is not lost during the reload. To reset the state, use hot
        // restart instead.
        //
        // This works for code too, not just values: Most code changes can be
        // tested with just a hot reload.
-        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
+        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepOrange),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}
```

--------------------------------

### Configure Android release with flavor and target

Source: https://docs.shorebird.dev/code-push/release

Specifies a custom entry point and build flavor for the Android release.

```bash
shorebird release android --target ./lib/main_development.dart --flavor development
```

--------------------------------

### Modify Flutter main.dart for patching

Source: https://docs.shorebird.dev/code-push/guides/staging-patches

Example modification to lib/main.dart to test a patch by changing the background color.

```dart
import 'package:flutter/material.dart';

void main() {
  runApp(const MainApp());
}

class MainApp extends StatelessWidget {
  const MainApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: Scaffold(
+       backgroundColor: Colors.cyan,
        body: Center(
          child: Text('Hello World!'),
        ),
      ),
    );
  }
}
```

--------------------------------

### Initialize with display name or organization ID

Source: https://docs.shorebird.dev/code-push/initialize

Use flags to specify a display name or bypass organization selection in non-interactive environments.

```bash
shorebird init --display-name "My App"
```

```bash
shorebird init --organization-id 42
```

--------------------------------

### Configure iOS release with flavor and target

Source: https://docs.shorebird.dev/code-push/release

Specifies a custom entry point and build flavor for the iOS release.

```bash
shorebird release ios --target ./lib/main_development.dart --flavor development
```

--------------------------------

### Example flutter doctor output

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

A sample of a healthy flutter doctor output on macOS, showing all checks passed.

```text
[✓] Flutter (Channel stable, 3.41.4, on macOS 26.2 25C56 darwin-arm64, locale
    en-IN) [605ms]
    • Flutter version 3.41.4 on channel stable at
      /Users/<username>/development/flutter
    • Upstream repository https://github.com/flutter/flutter.git
    • Framework revision 582a0e7c55 (5 days ago), 2026-02-12 17:12:32 -0800
    • Engine revision 3452d735bd
    • Dart version 3.11.1
    • DevTools version 2.54.1
    • Feature flags: enable-web, enable-linux-desktop, enable-macos-desktop,
      enable-windows-desktop, enable-android, enable-ios, cli-animations,
      enable-native-assets, omit-legacy-version-file, enable-lldb-debugging,
      enable-uiscene-migration

[✓] Android toolchain - develop for Android devices (Android SDK version 36.1.0)
    [1,702ms]
    • Android SDK at /Users/<username>/Library/Android/sdk
    • Emulator version 33.1.24.0 (build_id 11237101) (CL:N/A)
    • Platform android-36-ext19, build-tools 36.1.0
    • Java binary at: /Applications/Android
      Studio.app/Contents/jbr/Contents/Home/bin/java
      This is the JDK bundled with the latest Android Studio installation on
      this machine.
      To manually set the JDK path, use: `flutter config
      --jdk-dir="path/to/jdk"`.
    • Java version OpenJDK Runtime Environment (build
      17.0.10+0-17.0.10b1087.21-11572160)
    • All Android licenses accepted.

[✓] Xcode - develop for iOS and macOS (Xcode 26.2) [1,475ms]
    • Xcode at /Applications/Xcode.app/Contents/Developer
    • Build 17C52
    • CocoaPods version 1.16.2

[✓] Chrome - develop for the web [7ms]
    • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome

[✓] Connected device (3 available) [7.2s]
    • User’s iPhone (wireless) (mobile) • 00XXXX01-00XXXXXXXXXXXX1E • ios
      • iOS 26.0 2XXXX1
    • macOS (desktop)                    • macos                     •
      darwin-arm64   • macOS 26.2 25C56 darwin-arm64
    • Chrome (web)                       • chrome                    •
      web-javascript • Google Chrome 144.0.7559.135

[✓] Network resources [6.8s]
    • All expected network resources are available.

• No issues found!
```

--------------------------------

### Configure Shell Environment

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

Add Flutter to the PATH and configure Homebrew shell environment for Apple Silicon.

```bash
export PATH="$HOME/develop/flutter/bin:$PATH"
```

```bash
eval "$(/opt/homebrew/bin/brew shellenv)"
```

--------------------------------

### Create iOS releases for flavors

Source: https://docs.shorebird.dev/code-push/guides/flavors/ios

Use these commands to create separate releases for different iOS app flavors.

```bash
# Create a release for the internal flavor
shorebird release ios --flavor internal

# Create a release for the stable flavor
shorebird release ios --flavor stable
```

--------------------------------

### Example of asset change warning

Source: https://docs.shorebird.dev/code-push/troubleshooting

The warning message displayed by the shorebird patch command when it detects modifications to assets.

```text
✓ Verifying patch can be applied to release (4.0s)
[WARN] The release artifact contains asset changes, which will not be included in the patch.
    Added files:
        base/assets/flutter_assets/assets/images/bg_button_disable.png
    Changed files:
        base/assets/flutter_assets/AssetManifest.bin
        base/assets/flutter_assets/AssetManifest.json
        base/assets/flutter_assets/fonts/MaterialIcons-Regular.otf
Continue anyway? (y/N)
```

--------------------------------

### Expected Shorebird Doctor Output

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

A successful doctor check will verify connectivity to Shorebird services and the local Flutter installation.

```text
✓ https://api.shorebird.dev OK
✓ https://console.shorebird.dev OK
✓ Shorebird is up-to-date
✓ Flutter install is correct
No issues detected!
```

--------------------------------

### Resolve CocoaPods and Rosetta Issues

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

Commands to fix ffi gem errors and install Rosetta 2 on Apple Silicon.

```bash
sudo gem install ffi
sudo softwareupdate --install-rosetta --agree-to-license
```

--------------------------------

### Initialize Shorebird in Flutter

Source: https://docs.shorebird.dev/getting-started

Create a new project or initialize an existing one to generate the required configuration files.

```bash
shorebird create my_shorebird_app
cd my_shorebird_app
```

```bash
shorebird init
```

--------------------------------

### Accept Android SDK Licenses

Source: https://docs.shorebird.dev/flutter-concepts/how-to-install-flutter

Run this command to accept all required Android SDK licenses, which is mandatory before building Flutter applications.

```bash
flutter doctor --android-licenses
```

--------------------------------

### Release for multiple platforms

Source: https://docs.shorebird.dev/code-push/release

Use the --platforms option to build and publish releases for multiple platforms in a single command.

```bash
shorebird release --platforms=android,ios
```

--------------------------------

### Configure Flutter SDK path in VS Code

Source: https://docs.shorebird.dev/code-push/troubleshooting

Add this setting to your VS Code settings.json to explicitly point to your Flutter installation.

```json
"dart.flutterSdkPath": "/path/to/flutter"
```

--------------------------------

### Example of Dart compiler optimization impact

Source: https://docs.shorebird.dev/code-push/performance

Demonstrates how adding a function call can trigger re-optimization of existing code, potentially affecting patch performance.

```dart
bool isEven<T extends int?>(T value) => value?.isEven ?? false;

void foo(int x) {
  print(isEven(x));
}
```

```dart
bool isEven<T extends int?>(T value) => value?.isEven ?? false;

void foo(int x) {
  print(isEven(x));
}

+ void bar(int? x) {
+   print(isEven(x));
+ }
```

--------------------------------

### Create a Shorebird release

Source: https://docs.shorebird.dev/code-push/guides/stores/play-store

Execute the Shorebird CLI command to build the Android release and generate the necessary artifacts.

```bash
$ shorebird release android
✓ Building release (17.0s)
✓ Fetching apps (0.3s)
✓ Detecting release version (0.2s)

🚀 Ready to create a new release!

📱 App: time_shift (51751336-6a7c-4972-b4ec-8fc1591fb2b3)
📦 Release Version: 1.0.3+6
🕹️ Platform: android (arm64, arm32, x86_64)

Would you like to continue? (y/N) Yes
✓ Fetching releases (70ms)
✓ Fetching Flutter revision (22ms)
✓ Creating release (61ms)
✓ Creating artifacts (2.5s)

✅ Published Release!

Your next step is to upload the app bundle to the Play Store.
./build/app/outputs/bundle/release/app-release.aab

See the following link for more information:
https://support.google.com/googleplay/android-developer/answer/9859152?hl=en
```

--------------------------------

### Example build failure error output

Source: https://docs.shorebird.dev/code-push/troubleshooting

This error indicates a potential conflict between Shorebird's Flutter version and the system Flutter version in VS Code.

```text
FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':app:checkDebugAarMetadata'.
> Could not resolve all files for configuration ':app:debugRuntimeClasspath'.
   > Could not find io.flutter:arm64_v8a_debug:1.0.0-4a5e8142f3e7368a48e4f6151cb7b1a684d6dd83.
     Searched in the following locations:
```

--------------------------------

### GitHub Actions Patch Workflow

Source: https://docs.shorebird.dev/code-push/guides/development-workflow

A complete workflow configuration for patching Android and iOS apps, including environment setup, signing, and Shorebird patch execution.

```yaml
name: patch

on:
  push:
    tags:
      - 'v[0-9].[0-9]+.[0-9]+-hotfix.[0-9]+' # e.g. v1.0.0-hotfix.1

env:
  SHOREBIRD_TOKEN: ${{ secrets.SHOREBIRD_TOKEN }}

jobs:
  patch-android:
    runs-on: ubuntu-latest

    name: 🤖 Patch Android

    steps:
      - name: 📚 Git Checkout
        uses: actions/checkout@v7

      - name: ☕️ Setup Java
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'
          cache: gradle

      - name: 🐦 Setup Shorebird
        uses: shorebirdtech/setup-shorebird@v1
        with:
          cache: true

      - name: 🔐 Decode Keystore
        run:
          echo ${{ secrets.KEYSTORE }} | base64 --decode > ${{ github.workspace
          }}/keystore.jks

      - name: ✍️ Assemble Key Properties
        run: |
          echo "keyAlias=${{ secrets.KEYSTORE_ALIAS }}" >> ${{ github.workspace }}/android/key.properties
          echo "keyPassword=${{ secrets.KEYSTORE_PASSWORD }}" >> ${{ github.workspace }}/android/key.properties
          echo "storeFile=${{ github.workspace }}/keystore.jks" >> ${{ github.workspace }}/android/key.properties
          echo "storePassword=${{ secrets.KEYSTORE_PASSWORD }}" >> ${{ github.workspace }}/android/key.properties

      - name: 🧩 Shorebird Patch
        uses: shorebirdtech/shorebird-patch@v1
        id: shorebird-patch
        with:
          release-version: latest
          platform: android
          args: '--verbose --staging'

  patch-ios:
    runs-on: macos-latest

    name: 🍎 Patch iOS

    steps:
      - name: 📚 Git Checkout
        uses: actions/checkout@v7

      - name: 🐦 Setup Shorebird
        uses: shorebirdtech/setup-shorebird@v1
        with:
          cache: true

      - name: 🛠️ Setup Xcode
        uses: maxim-lobanov/setup-xcode@v1
        with:
          xcode-version: latest-stable

      - name: ✍️ Setup Xcode Signing
        env:
          CERTIFICATE: ${{ secrets.CERTIFICATE }}
          CERTIFICATE_PASSWORD: ${{ secrets.CERTIFICATE_PASSWORD }}
          PROVISIONING_PROFILE: ${{ secrets.PROVISIONING_PROFILE }}
          KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }}
        # https://docs.github.com/en/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development
        # Also adds a uuid to the mobile provision so XCode can find it.
        run: |
          # create variables
          CERTIFICATE_PATH=$RUNNER_TEMP/build_certificate.p12
          KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db
          PP_PATH=$RUNNER_TEMP/temp.mobileprovision

          # import certificate and provisioning profile from secrets
          echo -n "$CERTIFICATE" | base64 --decode -o $CERTIFICATE_PATH
          echo -n "$PROVISIONING_PROFILE" | base64 --decode -o $PP_PATH

          # create temporary keychain
          security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
          security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
          security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH

          # import certificate to keychain
          security import $CERTIFICATE_PATH -P "$CERTIFICATE_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
          security list-keychain -d user -s $KEYCHAIN_PATH
          security find-identity -v

          # use uuid for the name of provisioning profile
          UUID=$(/usr/libexec/PlistBuddy -c "Print UUID" /dev/stdin <<< $(/usr/bin/security cms -D -i $PP_PATH))

          # apply provisioning profile
          mkdir -p ~/Library/MobileDevice/Provisioning\ Profiles
          cp $PP_PATH ~/Library/MobileDevice/Provisioning\ Profiles/$UUID.mobileprovision

      - name: 🧩 Shorebird Patch
        uses: shorebirdtech/shorebird-patch@v1
        id: shorebird-patch
        with:
          release-version: latest
          platform: ios
          args: '--export-options-plist ios/GHAExportOptions.plist --staging'
```
Tokens:
Raw