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:
  account         Manage your Shorebird account.
  apps            Manage your Shorebird apps.
  cache           Manage the Shorebird cache.
  collaborators   Manage collaborators for a Shorebird app
  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.
  releases        Manage your 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.12.1 • git@github.com:shorebirdtech/shorebird.git
Flutter 3.10.6 • revision 0e2d280277cf9f60f7ba802a59f9fd187ffdd050
Engine • revision bf07ad7b0b777cb9aff15e59bf928504857f4ada

✓ Shorebird is up-to-date (0.8s)
✓ Flutter install is correct (3.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