ShorebirdCommand class

Main entry point for all Shorebird-related commands.

This command serves as the root command for the Shorebird CLI module, providing access to all Shorebird functionality through organized subcommands for releases and patches.

Subcommands

Release Commands

  • release: Create Shorebird releases for different platforms
    • apk: Release Android APK files
    • appbundle: Release Android App Bundle files
    • ios: Release iOS application bundles
    • ipa: Release iOS IPA files

Patch Commands

  • patch: Create Shorebird patches for existing releases
    • android: Create patches for Android applications
    • ios: Create patches for iOS applications

Usage

# Create releases
morpheme shorebird release apk --flavor prod
morpheme shorebird release ipa --flavor prod --export-method app-store

# Create patches
morpheme shorebird patch android --flavor prod
morpheme shorebird patch ios --flavor prod

About Shorebird

Shorebird Code Push enables over-the-air updates for Flutter applications, allowing developers to deploy bug fixes and feature updates instantly without requiring users to download a new version from app stores.

Features

  • Instant Updates: Deploy updates immediately to users
  • Platform Support: Works with Android (APK/AAB) and iOS (IPA)
  • Targeted Patches: Apply patches to specific app releases
  • Rollback Support: Revert problematic updates quickly
  • Development Integration: Seamless integration with existing workflows
Inheritance

Constructors

ShorebirdCommand()
Creates a new Shorebird command with all subcommands.

Properties

aliases → List<String>
Alternate names for this command.
no setterinherited
argParser → ArgParser
The argument parser for this command.
no setterinherited
argResults → ArgResults?
The parsed argument results for this command.
no setterinherited
category → String
The command's category.
no setteroverride
description → String
A description of this command, included in usage.
no setteroverride
globalResults → ArgResults?
The parsed global argument results.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hidden → bool
Whether or not this command should be hidden from help listings.
no setterinherited
invocation → String
A single-line template for how to invoke this command (e.g. "pub get package").
no setterinherited
name → String
The name of this command.
no setteroverride
parent → Command?
The command's parent command, if this is a subcommand.
no setterinherited
runner → CommandRunner?
The command runner for this command.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subcommands → Map<String, Command>
An unmodifiable view of all sublevel commands of this command.
no setterinherited
suggestionAliases → List<String>
Alternate non-functional names for this command.
no setterinherited
summary → String
A short description of this command, included in parent's CommandRunner.usage.
no setterinherited
takesArguments → bool
Whether or not this command takes positional arguments in addition to options.
no setterinherited
usage → String
Generates a string displaying usage information for this command.
no setterinherited
usageFooter → String?
An optional footer for usage.
no setterinherited

Methods

addSubcommand(Command command) → void
Adds Command as a subcommand of this.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
printUsage() → void
Prints the usage information for this command.
inherited
run() → FutureOr?
Runs this command.
inherited
toString() → String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited