generated: '2026-07-21'
method: searched
source: https://docs.shorebird.dev/
name: shorebird
description: >-
  First-party command-line tool for Shorebird code push. Installs a bundled,
  code-push-enabled copy of Flutter under ~/.shorebird and drives all release,
  patch, and account operations against the Shorebird service.
install:
- method: script
  command: "curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash"
  platforms: [macos, linux]
- method: powershell
  command: "Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' -OutFile install.ps1; .\\install.ps1"
  platforms: [windows]
repository: https://github.com/shorebirdtech/shorebird
authentication:
  interactive: shorebird login
  ci: shorebird login:ci
  ci_token_env: SHOREBIRD_TOKEN
  note: >-
    Interactive login authenticates via the Shorebird console; CI environments
    export a token generated by `shorebird login:ci` as SHOREBIRD_TOKEN.
commands:
- group: auth
  commands:
  - {name: login, summary: Authenticate with the Shorebird service}
  - {name: 'login:ci', summary: Generate a token for use in continuous integration}
  - {name: logout, summary: Sign out of the current session}
- group: setup
  commands:
  - {name: init, summary: Initialize Shorebird in the current Flutter project and assign an app_id}
  - {name: doctor, summary: Show information about the installed Shorebird tooling and diagnose issues}
  - {name: cache, summary: Manage the Shorebird cache (e.g. clean)}
  - {name: upgrade, summary: Upgrade the Shorebird CLI to the latest version}
  - {name: flutter, summary: Manage the internal Flutter installation used by Shorebird}
- group: release
  commands:
  - {name: release, summary: 'Build and submit a new release (android, ios, linux, macos, windows)'}
  - {name: releases, summary: 'List and inspect releases (list, get, delete)'}
- group: patch
  commands:
  - {name: patch, summary: 'Create and upload an over-the-air patch to an existing release (per platform)'}
  - {name: patches, summary: 'Manage patches: list, view detail, promote, and assign tracks'}
  - {name: preview, summary: Preview a release or patch on a device before shipping}
- group: apps
  commands:
  - {name: apps, summary: 'Manage Shorebird apps (create, list, delete)'}
  - {name: account, summary: 'Manage the Shorebird account and usage'}
key_flags:
- {flag: '--platforms/-p', summary: Build for multiple platforms at once (e.g. android,ios)}
- {flag: '--release-version', summary: 'Target release to patch (a version like 1.0.0+1, or latest)'}
- {flag: '--track', summary: 'Deployment channel: stable (default) or staging'}
- {flag: '--dry-run/-n', summary: Validate without uploading (useful in CI)}
- {flag: '--flavor', summary: Apply a product flavor}
- {flag: '--target/-t', summary: Specify the entrypoint file}
key_flows:
- {name: Ship a patch, steps: 'shorebird init -> shorebird release android -> shorebird patch android'}
- {name: CI release, steps: 'export SHOREBIRD_TOKEN -> shorebird release android --dry-run -> shorebird patch android'}
- {name: Staged rollout, steps: 'shorebird patch android --track=staging -> shorebird patches promote'}