From 0ca9737a65f431d46451378048f48a48a4e05847 Mon Sep 17 00:00:00 2001 From: hashirshoaeb Date: Wed, 27 May 2026 07:23:18 +0500 Subject: [PATCH 01/11] docs: rewrite Welcome and Quick Start pages for clarity and onboarding UX - Remove Welcome from sidebar (root pages conventionally hidden) - Add product description, prerequisites, and nav cards to Welcome page - Add scope statement, prerequisites, and Installation heading to Quick Start - Wrap steps in component; use for install method and app type - Add "Install with AI" tab with copy-pasteable LLM prompt - Remove shorebird CLI help output dump; use `shorebird doctor` instead - Add terminal restart instruction before PATH verification step - Fix passive voice, typos, filler sentences, and duplicate welcome messages --- astro.config.mjs | 1 - src/content/docs/getting-started/index.mdx | 211 ++++++++------------- src/content/docs/index.mdx | 40 +++- 3 files changed, 112 insertions(+), 140 deletions(-) diff --git a/astro.config.mjs b/astro.config.mjs index 79ea1075..dadfc322 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -69,7 +69,6 @@ export default defineConfig({ }, customCss: ['./src/styles/custom.css'], sidebar: [ - { label: 'Welcome', link: '/' }, { label: 'Getting Started', collapsed: true, diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index fd6436c2..e1bfa675 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -1,6 +1,6 @@ --- title: Quick Start -description: The easy way to get started with Shorebird +description: Install Shorebird and push your first patch. sidebar: order: 1 --- @@ -10,180 +10,131 @@ import { LinkButton, LinkCard, } from 'starlight-theme-nova/components'; +import { Steps, Tabs, TabItem } from '@astrojs/starlight/components'; -Welcome to Shorebird! πŸ‘‹ +{/* TODO: Add 2-minute installation walkthrough video */} -In this guide, we'll walk you through setting up Shorebird and integrating it -into your app in just a few minutes. +This guide walks you through installing Shorebird and integrating it into your Flutter app. -## Sign up +## Prerequisites -The first thing you'll need to do is sign up for a Shorebird account. It's free -to do and you can signup in a manner of seconds. +- Flutter 3.24.0 or later ([install Flutter](https://docs.flutter.dev/get-started/install)) +- `git` installed locally - - Create an Account - +## Installation -## Install + -While a full install may not be required to access and use all of our product -offerings, we recommend installing everything locally to make debugging easier -as you continue using our services. +1. **Sign up** for a free Shorebird account. -### Using install script + + Create an Account + -To install the Shorebird command line interface (CLI): +2. **Install Shorebird.** - -```bash title="Mac/Linux" -curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash -``` + + -```powershell title="Windows" -Set-ExecutionPolicy RemoteSigned -scope CurrentUser # Needed to execute remote scripts -iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1'|iex -``` + Paste the following into any AI assistant (Claude, ChatGPT, etc.) for guided installation: - + ``` + Install Shorebird on my machine. Shorebird is a Flutter code push tool. -:::note + Mac/Linux: + curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash -Installing Shorebird CLI requires `git`. + Windows: + Set-ExecutionPolicy RemoteSigned -scope CurrentUser + iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex -::: + After installing, run `shorebird doctor` to verify and help me fix any issues. + ``` -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. + + -### Manually installing + Run the install script for your platform: -Shorebird can also be manually installed, allowing users to choose where the -installation will be placed. + + ```bash title="Mac/Linux" + curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash + ``` -In order to do so, in a terminal, inside the folder where Shorebird should be -installed at, run: + ```powershell title="Windows" + Set-ExecutionPolicy RemoteSigned -scope CurrentUser + iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex + ``` + -```bash -git clone -b stable https://github.com/shorebirdtech/shorebird.git -``` + This installs `shorebird` into `~/.shorebird/bin` and adds it to your `PATH`. It also installs a bundled copy of Flutter at `~/.shorebird/bin/cache/flutter` β€” modified to support code push and separate from your existing Flutter install. -Add the `bin` folder from the repository you just cloned into your `PATH`. + + -:::note + Clone the repository into the directory where you want Shorebird installed: -The total installation is about 300mb. + ```bash + git clone -b stable https://github.com/shorebirdtech/shorebird.git + ``` -::: + Add the `bin` folder to your `PATH`. -Once the installation has completed, `shorebird` should be available in your -terminal: + :::note + The total installation size is about 300 MB. + ::: -``` -$ shorebird -The shorebird command-line tool + + -Usage: shorebird [arguments] + Restart your terminal to reload your `PATH`, then verify your setup: -Global options: --h, --help Print this usage information. - --version Print the current version. --v, --[no-]verbose Noisy logging, including all shell commands executed. + ```sh + shorebird doctor + ``` -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 Creates a shorebird patch for the provided target platforms - patches Manage Shorebird patches - preview Preview a specific release on a device. - release Creates a shorebird release for the provided target platforms - releases Manage Shorebird releases - upgrade Upgrade your copy of Shorebird. +3. **Log in** to your Shorebird account. -Run "shorebird help " for more information about a command. -``` + `shorebird login` opens a browser window for authentication. Return to your terminal after logging in. -You can use the `shorebird doctor` to ensure things are setup correctly: + ```sh + shorebird login + ``` -```sh -shorebird doctor -``` +4. **Integrate Shorebird** into your Flutter app. -Example output: + + -``` -$ shorebird doctor -Shorebird 1.5.1 β€’ git@github.com:shorebirdtech/shorebird.git -Flutter 3.27.0 β€’ revision 1e0e5760eeaf534c280cf59ee0504d0e2ba12a7b -Engine β€’ revision 59571a1190752bc1740bff652ce5f0ba7c9413f8 + Create a new Flutter app with Shorebird: -URL Reachability -βœ“ https://api.shorebird.dev OK (0.1s) -βœ“ https://console.shorebird.dev OK (0.1s) -βœ“ https://oauth2.googleapis.com OK (60ms) -βœ“ https://storage.googleapis.com OK (0.2s) -βœ“ https://cdn.shorebird.cloud OK (0.1s) + ```sh + shorebird create my_shorebird_app + cd my_shorebird_app + ``` -βœ“ Shorebird is up-to-date (1.4s) -βœ“ Flutter install is correct (0.4s) + + -No issues detected! -``` + In your Flutter app's root directory, run: -Finally, you can log in to your Shorebird account on your machine: + ```sh + shorebird init + ``` -```sh -shorebird login -``` + This creates a `shorebird.yaml` file containing your `app_id`. Your `app_id` is not secret and can be committed to source control. -## Integrate Shorebird + + -Your now ready to add Shorebird to your app. + :::note + Shorebird supports Flutter 3.24.0 and later. See [Flutter Version Management](/getting-started/flutter-version) to configure an older version. + ::: -You can start by creating a new Flutter app or navigating to the directory of -your already created Flutter app. - -To create a new Flutter app: - -```sh -shorebird create my_shorebird_app -cd my_shorebird_app -``` - -Or, to enable Shorebird for an existing Flutter app run: - -```sh -shorebird init -``` - -This will create a `shorebird.yaml` file in the root of your project. This file -contains your Shorebird `app_id`. Your `app_id` is not secret and can be checked -into source control and freely shared. - -This will also run `shorebird doctor` to ensure everything is set up correctly. - -:::note - -Shorebird expects to find the latest stable `flutter` installed on your machine. -Shorebird can be configured to work with older versions of Flutter (back to -3.10.0). See [Flutter Version Management](/getting-started/flutter-version) for -more info. - -::: + ## Next Steps -Now that your account is set up and your app is initialized, you're all set to -begin. - Quick Start +## Explore the Docs + + + + + ## Contact Us -Still have questions? We are here to help and can be contacted in a variety of -ways. +Still have questions? Reach us through any of these channels. Date: Wed, 27 May 2026 14:42:31 +0000 Subject: [PATCH 02/11] docs: improve formatting and readability in Quick Start and Welcome pages --- src/content/docs/getting-started/index.mdx | 109 +++++++++++---------- src/content/docs/index.mdx | 8 +- 2 files changed, 64 insertions(+), 53 deletions(-) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index e1bfa675..110fd624 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -14,11 +14,13 @@ import { Steps, Tabs, TabItem } from '@astrojs/starlight/components'; {/* TODO: Add 2-minute installation walkthrough video */} -This guide walks you through installing Shorebird and integrating it into your Flutter app. +This guide walks you through installing Shorebird and integrating it into your +Flutter app. ## Prerequisites -- Flutter 3.24.0 or later ([install Flutter](https://docs.flutter.dev/get-started/install)) +- Flutter 3.24.0 or later + ([install Flutter](https://docs.flutter.dev/get-started/install)) - `git` installed locally ## Installation @@ -34,58 +36,61 @@ This guide walks you through installing Shorebird and integrating it into your F 2. **Install Shorebird.** - + - Paste the following into any AI assistant (Claude, ChatGPT, etc.) for guided installation: + Paste the following into any AI assistant (Claude, ChatGPT, etc.) for guided + installation: - ``` - Install Shorebird on my machine. Shorebird is a Flutter code push tool. + ``` + Install Shorebird on my machine. Shorebird is a Flutter code push tool. - Mac/Linux: - curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash + Mac/Linux: + curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash - Windows: - Set-ExecutionPolicy RemoteSigned -scope CurrentUser - iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex + Windows: + Set-ExecutionPolicy RemoteSigned -scope CurrentUser + iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex - After installing, run `shorebird doctor` to verify and help me fix any issues. - ``` + After installing, run `shorebird doctor` to verify and help me fix any issues. + ``` - + - Run the install script for your platform: + Run the install script for your platform: - ```bash title="Mac/Linux" - curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash - ``` - - ```powershell title="Windows" - Set-ExecutionPolicy RemoteSigned -scope CurrentUser - iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex - ``` + ```bash title="Mac/Linux" + curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash + ``` + + ```powershell title="Windows" + Set-ExecutionPolicy RemoteSigned -scope CurrentUser + iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex + ``` + - This installs `shorebird` into `~/.shorebird/bin` and adds it to your `PATH`. It also installs a bundled copy of Flutter at `~/.shorebird/bin/cache/flutter` β€” modified to support code push and separate from your existing Flutter install. + This installs `shorebird` into `~/.shorebird/bin` and adds it to your `PATH`. + It also installs a bundled copy of Flutter at + `~/.shorebird/bin/cache/flutter` β€” modified to support code push and separate + from your existing Flutter install. - + - Clone the repository into the directory where you want Shorebird installed: + Clone the repository into the directory where you want Shorebird installed: - ```bash - git clone -b stable https://github.com/shorebirdtech/shorebird.git - ``` + ```bash + git clone -b stable https://github.com/shorebirdtech/shorebird.git + ``` - Add the `bin` folder to your `PATH`. + Add the `bin` folder to your `PATH`. - :::note - The total installation size is about 300 MB. - ::: + :::note The total installation size is about 300 MB. ::: - + Restart your terminal to reload your `PATH`, then verify your setup: @@ -95,7 +100,8 @@ This guide walks you through installing Shorebird and integrating it into your F 3. **Log in** to your Shorebird account. - `shorebird login` opens a browser window for authentication. Return to your terminal after logging in. + `shorebird login` opens a browser window for authentication. Return to your + terminal after logging in. ```sh shorebird login @@ -104,32 +110,33 @@ This guide walks you through installing Shorebird and integrating it into your F 4. **Integrate Shorebird** into your Flutter app. - + - Create a new Flutter app with Shorebird: + Create a new Flutter app with Shorebird: - ```sh - shorebird create my_shorebird_app - cd my_shorebird_app - ``` + ```sh + shorebird create my_shorebird_app + cd my_shorebird_app + ``` - + - In your Flutter app's root directory, run: + In your Flutter app's root directory, run: - ```sh - shorebird init - ``` + ```sh + shorebird init + ``` - This creates a `shorebird.yaml` file containing your `app_id`. Your `app_id` is not secret and can be committed to source control. + This creates a `shorebird.yaml` file containing your `app_id`. Your `app_id` + is not secret and can be committed to source control. - + - :::note - Shorebird supports Flutter 3.24.0 and later. See [Flutter Version Management](/getting-started/flutter-version) to configure an older version. - ::: + :::note Shorebird supports Flutter 3.24.0 and later. See + [Flutter Version Management](/getting-started/flutter-version) to configure + an older version. ::: diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 453794b8..eefcc9e2 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -7,13 +7,17 @@ import { LinkButton, LinkCard } from 'starlight-theme-nova/components'; ## What is Shorebird? -Shorebird lets you push code updates to your Flutter app instantly, without waiting for app store review. These docs are for Flutter developers integrating Shorebird into new or existing flutter apps. These docs cover everything from your first integration to your custom deployment workflows. +Shorebird lets you push code updates to your Flutter app instantly, without +waiting for app store review. These docs are for Flutter developers integrating +Shorebird into new or existing flutter apps. These docs cover everything from +your first integration to your custom deployment workflows. ## Before You Begin You'll need the following before getting started: -- [Flutter 3.24.0 or later](https://docs.flutter.dev/install/quick) installed locally +- [Flutter 3.24.0 or later](https://docs.flutter.dev/install/quick) installed + locally - [Git](https://git-scm.com) installed locally
From f9a0a67042d1f75675a9dc2e532994798ef69f85 Mon Sep 17 00:00:00 2001 From: Hashir Shoaib Date: Wed, 27 May 2026 15:50:46 +0000 Subject: [PATCH 03/11] docs: formatting and build fixes --- src/content/docs/getting-started/index.mdx | 165 +++++++++++---------- 1 file changed, 90 insertions(+), 75 deletions(-) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index 110fd624..6a3c139a 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -27,116 +27,131 @@ Flutter app. -1. **Sign up** for a free Shorebird account. +1. **Sign up** for a free Shorebird account. - - Create an Account - + + Create an Account + -2. **Install Shorebird.** +2. **Install Shorebird.** - - + - Paste the following into any AI assistant (Claude, ChatGPT, etc.) for guided - installation: + - ``` - Install Shorebird on my machine. Shorebird is a Flutter code push tool. + Paste the following into any AI assistant (Claude, ChatGPT, etc.) for guided + installation: - Mac/Linux: - curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash + ``` + Install Shorebird on my machine. Shorebird is a Flutter code push tool. - Windows: - Set-ExecutionPolicy RemoteSigned -scope CurrentUser - iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex + Mac/Linux: + curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash - After installing, run `shorebird doctor` to verify and help me fix any issues. - ``` + Windows: + Set-ExecutionPolicy RemoteSigned -scope CurrentUser + iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex - - + After installing, run `shorebird doctor` to verify and help me fix any issues. + ``` - Run the install script for your platform: + - - ```bash title="Mac/Linux" - curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash - ``` + - ```powershell title="Windows" - Set-ExecutionPolicy RemoteSigned -scope CurrentUser - iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex - ``` + Run the install script for your platform: - + + ```bash title="Mac/Linux" + curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | bash + ``` - This installs `shorebird` into `~/.shorebird/bin` and adds it to your `PATH`. - It also installs a bundled copy of Flutter at - `~/.shorebird/bin/cache/flutter` β€” modified to support code push and separate - from your existing Flutter install. + ```powershell title="Windows" + Set-ExecutionPolicy RemoteSigned -scope CurrentUser + iwr -UseBasicParsing 'https://raw.githubusercontent.com/shorebirdtech/install/main/install.ps1' | iex + ``` + - - + This installs `shorebird` into `~/.shorebird/bin` and adds it to your `PATH`. + It also installs a bundled copy of Flutter at + `~/.shorebird/bin/cache/flutter` β€” modified to support code push and separate + from your existing Flutter install. - Clone the repository into the directory where you want Shorebird installed: + - ```bash - git clone -b stable https://github.com/shorebirdtech/shorebird.git - ``` + - Add the `bin` folder to your `PATH`. + Clone the repository into the directory where you want Shorebird installed: - :::note The total installation size is about 300 MB. ::: + ```bash + git clone -b stable https://github.com/shorebirdtech/shorebird.git + ``` - - + Add the `bin` folder to your `PATH`. - Restart your terminal to reload your `PATH`, then verify your setup: + :::note + The total installation size is about 300 MB. + ::: - ```sh - shorebird doctor - ``` + -3. **Log in** to your Shorebird account. + - `shorebird login` opens a browser window for authentication. Return to your - terminal after logging in. +3. **Verify** your setup. - ```sh - shorebird login - ``` + Restart your terminal to reload your `PATH`, then verify your setup by + running the following command: -4. **Integrate Shorebird** into your Flutter app. + ```sh + shorebird doctor + ``` - - +4. **Log in** to your Shorebird account. - Create a new Flutter app with Shorebird: + `shorebird login` opens a browser window for authentication. Return to your + terminal after logging in. - ```sh - shorebird create my_shorebird_app - cd my_shorebird_app - ``` + ```sh + shorebird login + ``` - - +5. **Integrate Shorebird** into your Flutter app. - In your Flutter app's root directory, run: + - ```sh - shorebird init - ``` + - This creates a `shorebird.yaml` file containing your `app_id`. Your `app_id` - is not secret and can be committed to source control. + Create a new Flutter app with Shorebird: - - + ```sh + shorebird create my_shorebird_app + cd my_shorebird_app + ``` - :::note Shorebird supports Flutter 3.24.0 and later. See - [Flutter Version Management](/getting-started/flutter-version) to configure - an older version. ::: + + + + + In your Flutter app's root directory, run: + + ```sh + shorebird init + ``` + + This creates a `shorebird.yaml` file containing your `app_id`. Your `app_id` + is not secret and can be committed to source control. + + + + + + :::note + + Shorebird supports Flutter 3.24.0 and later. See + [Flutter Version Management](/getting-started/flutter-version) to configure + an older version. + + ::: From 83bf33a0fc753de7d4a295ec02180d1135982c33 Mon Sep 17 00:00:00 2001 From: hashirshoaeb Date: Tue, 9 Jun 2026 09:26:52 +0500 Subject: [PATCH 04/11] docs: remove note about installation size from Quick Start guide --- src/content/docs/getting-started/index.mdx | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index 6a3c139a..0c3facc4 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -89,9 +89,6 @@ Flutter app. Add the `bin` folder to your `PATH`. - :::note - The total installation size is about 300 MB. - ::: From 2e48af2d0a87cf166a11883bc7f1c3e51a84390c Mon Sep 17 00:00:00 2001 From: hashirshoaeb Date: Tue, 9 Jun 2026 09:27:13 +0500 Subject: [PATCH 05/11] docs: correct capitalization of "Flutter" in introduction --- src/content/docs/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index eefcc9e2..07ec11fc 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -9,7 +9,7 @@ import { LinkButton, LinkCard } from 'starlight-theme-nova/components'; Shorebird lets you push code updates to your Flutter app instantly, without waiting for app store review. These docs are for Flutter developers integrating -Shorebird into new or existing flutter apps. These docs cover everything from +Shorebird into new or existing Flutter apps. These docs cover everything from your first integration to your custom deployment workflows. ## Before You Begin From 34836d387e04eade179fd126bd18b4d72818588e Mon Sep 17 00:00:00 2001 From: hashirshoaeb Date: Tue, 9 Jun 2026 09:29:46 +0500 Subject: [PATCH 06/11] docs: remove unnecessary blank line in installation instructions --- src/content/docs/getting-started/index.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index 0c3facc4..a38b6c07 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -89,7 +89,6 @@ Flutter app. Add the `bin` folder to your `PATH`. - From 458692dbf049a697d201f405e58b0b0b8947fef0 Mon Sep 17 00:00:00 2001 From: hashirshoaeb Date: Fri, 19 Jun 2026 06:26:39 +0500 Subject: [PATCH 07/11] fix: update description for Quick Start guide to reflect creating a release --- src/content/docs/getting-started/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index a38b6c07..c12de0fb 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -1,6 +1,6 @@ --- title: Quick Start -description: Install Shorebird and push your first patch. +description: Install Shorebird and create your first release. sidebar: order: 1 --- From 0556f9dc9955d1225aa035d71a627f691e421f7a Mon Sep 17 00:00:00 2001 From: hashirshoaeb Date: Fri, 19 Jun 2026 06:47:19 +0500 Subject: [PATCH 08/11] fix: add example output for shorebird doctor command in Quick Start guide --- src/content/docs/getting-started/index.mdx | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index c12de0fb..828544ef 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -102,6 +102,27 @@ Flutter app. shorebird doctor ``` + Example output: + + ``` + $ shorebird doctor + Shorebird 1.5.1 β€’ git@github.com:shorebirdtech/shorebird.git + Flutter 3.27.0 β€’ revision 1e0e5760eeaf534c280cf59ee0504d0e2ba12a7b + Engine β€’ revision 59571a1190752bc1740bff652ce5f0ba7c9413f8 + + URL Reachability + βœ“ https://api.shorebird.dev OK (0.1s) + βœ“ https://console.shorebird.dev OK (0.1s) + βœ“ https://oauth2.googleapis.com OK (60ms) + βœ“ https://storage.googleapis.com OK (0.2s) + βœ“ https://cdn.shorebird.cloud OK (0.1s) + + βœ“ Shorebird is up-to-date (1.4s) + βœ“ Flutter install is correct (0.4s) + + No issues detected! + ``` + 4. **Log in** to your Shorebird account. `shorebird login` opens a browser window for authentication. Return to your From 2048400515b626d4145b23137557281772a3db3d Mon Sep 17 00:00:00 2001 From: hashirshoaeb Date: Fri, 19 Jun 2026 19:44:34 +0500 Subject: [PATCH 09/11] fix: add instruction to run `shorebird --help` for available commands in Quick Start guide --- src/content/docs/getting-started/index.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index 828544ef..3184b5b9 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -93,6 +93,8 @@ Flutter app. + Run `shorebird --help` to see all available commands. + 3. **Verify** your setup. Restart your terminal to reload your `PATH`, then verify your setup by From 7a09c6d74712be5615816029d0a57aa6edb6ca4a Mon Sep 17 00:00:00 2001 From: hashirshoaeb Date: Thu, 25 Jun 2026 08:37:37 +0500 Subject: [PATCH 10/11] docs: PATH setup examples for Bash/Zsh and PowerShell from main added --- src/content/docs/getting-started/index.mdx | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx index 47b7d362..17c853b3 100644 --- a/src/content/docs/getting-started/index.mdx +++ b/src/content/docs/getting-started/index.mdx @@ -87,7 +87,19 @@ Flutter app. git clone -b stable https://github.com/shorebirdtech/shorebird.git ``` - Add the `bin` folder to your `PATH`. + Add the `bin` folder to your `PATH`, for example: + + + ```bash title="Bash/Zsh" + # Add to shell profile (e.g., ~/.zshrc or ~/.bashrc) + export PATH="$PATH:/path/to/cloned/shorebird/bin" + ``` + + ```powershell title="Windows PowerShell" + # Add to User PATH variable + [Environment]::SetEnvironmentVariable("PATH", "$env:PATH;C:\path\to\cloned\shorebird\bin", "User") + ``` + From b816402d80f61a66b73460876b5094523461b97b Mon Sep 17 00:00:00 2001 From: hashirshoaeb Date: Thu, 25 Jun 2026 21:09:28 +0500 Subject: [PATCH 11/11] docs: update CI Integration link to point to the suggested path --- src/content/docs/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 07ec11fc..2097fe69 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -39,7 +39,7 @@ You'll need the following before getting started: description="Learn how code push works, manage releases and patches, and configure update strategies." />