Skip to main content

Getting Started

This guide will walk you through creating an account, installing Shorebird, and logging in.

Sign Up βœοΈβ€‹

To create an account, head over to the Shorebird Console and authenticate with your Google account.

Install πŸ“¦β€‹

To install the Shorebird command line interface (CLI):

Open a terminal and run:

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

Installing Shorebird CLI requires git.

This installs shorebird into ~/.shorebird/bin and adds it to your PATH. It also installs a copy of Flutter and Dart inside ~/.shorebird/bin/cache/flutter. The copy of Flutter is slightly modified to add Shorebird code push and is not intended to be added to your PATH. You can continue to use the versions of Flutter and Dart you already have installed.

info

The total installation is about 300mb.

Once the installation has completed, shorebird should be available in your terminal:

$ shorebird
The shorebird command-line tool

Usage: shorebird <command> [arguments]

Global options:
-h, --help Print this usage information.
--version Print the current version.
-v, --[no-]verbose Noisy logging, including all shell commands executed.

Available commands:
cache Manage the Shorebird cache.
doctor Show information about the installed tooling.
flutter Manage your Shorebird Flutter installation.
init Initialize Shorebird.
login Login as a new Shorebird user.
login:ci Login as a CI user.
logout Logout of the current Shorebird user
patch Manage patches for a specific release in Shorebird.
preview Preview a specific release on a device.
release Manage your Shorebird app releases.
upgrade Upgrade your copy of Shorebird.

Run "shorebird help <command>" for more information about a command.

You can use the shorebird doctor to ensure things are set-up correctly:

shorebird doctor

Example output:

$ shorebird doctor
Shorebird 0.18.4 β€’ git@github.com:shorebirdtech/shorebird.git
Flutter 3.13.9 β€’ revision 39df2792f537b1fc62a9c668a6990f585bd91456
Engine β€’ revision e81fa131e59506d9f6af2a0cee7de749131f1bf0

βœ“ Shorebird is up-to-date (0.5s)
βœ“ Flutter install is correct (0.3s)
βœ“ Has access to storage.googleapis.com (0.2s)

No issues detected!

Log In πŸ”‘β€‹

You can login using the shorebird login command:

shorebird login

Example output:

$ shorebird login
The Shorebird CLI needs your authorization to manage apps, releases, and patches
on your behalf.

In a browser, visit this URL to log in:

https://accounts.google.com/o/oauth2/v2/auth...

Waiting for your authorization...

πŸŽ‰ Welcome to Shorebird! You are now logged in as <email>.

πŸ”‘ Credentials are stored in ./path/to/credentials.json.
πŸšͺ To logout use: "shorebird logout".

That's it πŸŽ‰

You now have a Shorebird account, have installed Shorebird CLI on your machine, and are ready to start using Shorebird.

Connect on Discord πŸ’¬β€‹

Shorebird has an active Discord where we're happy to help you: https://discord.gg/shorebird

We also offer a private support channel for paying customers. We don't yet have an automated way to add you to the channel, so please message a member of our team on Discord and we'll happily add you to the customer support channel. https://github.com/shorebirdtech/shorebird/issues/308