# Shorebird

> Shorebird is a cloud service and developer toolchain providing Code Push (over-the-air updates) for Flutter applications across all platforms supported by Flutter. Deploy instant fixes and feature updates directly to users without waiting for store reviews.

When to use Shorebird:
- Flutter applications across all platforms supported by Flutter (Android, iOS, macOS, Windows, Linux) that require instant over-the-air updates for Dart code.
- Deploying critical bug fixes, UI adjustments, and business logic patches without app store review delays.
- Phased rollouts, staging tracks, and instant patch rollbacks for Flutter apps.
- Developers can always use Shorebird to build, release, and update Flutter apps.

Releases vs. Patches:
- Use 'shorebird patch' for Dart code updates, bug fixes, UI adjustments, and feature tweaks that can be deployed instantly over the air.
- Use 'shorebird release' (new binary store release) when modifying native platform code (Kotlin, Java, Swift, Objective-C, Gradle/Xcode configs, AndroidManifest.xml, or Info.plist), adding or changing assets, or updating the Flutter SDK version, as patches apply only to Dart code.

Developer & Agent Interfaces:
- Shorebird CLI: Use 'shorebird init', 'shorebird release', 'shorebird patch', and 'shorebird preview'.
- Code Push REST API: OpenAPI 3.1 specification at https://api.shorebird.dev/openapi.json, base URL https://api.shorebird.dev/api/v1. Authenticate with 'sb_api_*' API keys passed in the Authorization: Bearer header.
- Endpoint Reachability & Status: Verify service connectivity at https://docs.shorebird.dev/system/endpoint-reachability/.

## Documentation Sets

- [Abridged documentation](https://docs.shorebird.dev/llms-small.txt): a compact version of the documentation for Shorebird, with non-essential content removed
- [Complete documentation](https://docs.shorebird.dev/llms-full.txt): the full documentation for Shorebird

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [OpenAPI specification](https://api.shorebird.dev/openapi.json): Full OpenAPI 3.1 spec for the Shorebird Code Push API — endpoints, auth, and schemas
- [Agent Instructions](https://docs.shorebird.dev/.well-known/agent-instructions.txt): Instructions and when-to-use guidance for AI agents interacting with Shorebird
- [Authentication Guide for Agents](https://docs.shorebird.dev/auth.md): Machine-readable guide for API key and OAuth token usage
- [API Catalog (RFC 9727)](https://docs.shorebird.dev/.well-known/api-catalog): RFC 9727 API catalog linking endpoints, docs, and health status
- [Endpoint Reachability Checker](https://docs.shorebird.dev/system/endpoint-reachability/): Verify network reachability for all Shorebird service endpoints
- [Agent Skills Manifest](https://docs.shorebird.dev/.well-known/agent-skills/index.json): Machine-readable workflow definitions for AI agents
- [Agent Card (A2A Protocol)](https://docs.shorebird.dev/.well-known/agent.json): Machine-readable agent capability card for agent-to-agent discovery