├── .github ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── bug_report.md │ └── feature_request.md ├── PULL_REQUEST_TEMPLATE.md ├── main.yaml └── workflows │ └── e2e.yaml ├── COPYRIGHT ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── install.ps1 └── install.sh /.github/ISSUE_TEMPLATE/ config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Create a report to help us improve 4 | title: "fix: " 5 | labels: bug 6 | --- 7 | 8 | **Description** 9 | 10 | A clear and concise description of what the bug is. 11 | 12 | **Steps To Reproduce** 13 | 14 | 1. Go to '...' 15 | 2. Click on '....' 16 | 3. Scroll down to '....' 17 | 4. See error 18 | 19 | **Expected Behavior** 20 | 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | 25 | If applicable, add screenshots to help explain your problem. 26 | 27 | **Additional Context** 28 | 29 | Add any other context about the problem here. 30 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: A new feature to be added to the project 4 | title: "feat: " 5 | labels: feature 6 | --- 7 | 8 | **Description** 9 | 10 | Clearly describe what you are looking to add. The more context the better. 11 | 12 | **Requirements** 13 | 14 | - [ ] Checklist of requirements to be fulfilled 15 | 16 | **Additional Context** 17 | 18 | Add any other context or screenshots about the feature request go here. 19 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 8 | 9 | ## Description 10 | 11 | 12 | 13 | ## Type of Change 14 | 15 | 16 | 17 | - [ ] ✨ New feature (non-breaking change which adds functionality) 18 | - [ ] 🛠️ Bug fix (non-breaking change which fixes an issue) 19 | - [ ] ❌ Breaking change (fix or feature that would cause existing functionality to change) 20 | - [ ] 🧹 Code refactor 21 | - [ ] ✅ Build configuration change 22 | - [ ] 📝 Documentation 23 | - [ ] 🗑️ Chore 24 | -------------------------------------------------------------------------------- /.github/main.yaml: -------------------------------------------------------------------------------- 1 | name: ci 2 | 3 | on: 4 | pull_request: 5 | branches: 6 | - main 7 | 8 | jobs: 9 | semantic_pull_request: 10 | name: ✅ Semantic Pull Request 11 | uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/semantic_pull_request.yml@v1 12 | -------------------------------------------------------------------------------- /.github/workflows/e2e.yaml: -------------------------------------------------------------------------------- 1 | name: e2e 2 | 3 | on: 4 | pull_request: 5 | push: 6 | branches: 7 | - main 8 | 9 | jobs: 10 | install: 11 | strategy: 12 | fail-fast: false 13 | matrix: 14 | os: [macos-latest, windows-latest, ubuntu-latest] 15 | 16 | runs-on: ${{ matrix.os }} 17 | 18 | steps: 19 | - name: 📚 Git Checkout 20 | uses: actions/checkout@v3 21 | 22 | - name: 📦 Install Shorebird CLI (bash) 23 | if: matrix.os == 'macos-latest' || matrix.os == 'ubuntu-latest' 24 | run: ./install.sh 25 | shell: bash 26 | 27 | - name: 📦 Install Shorebird CLI (powershell) 28 | if: matrix.os == 'windows-latest' 29 | run: ./install.ps1 30 | shell: pwsh 31 | -------------------------------------------------------------------------------- /COPYRIGHT: -------------------------------------------------------------------------------- 1 | Licensed under either of Apache License, Version 2.0 (LICENSE-APACHE or 2 | http://www.apache.org/licenses/LICENSE-2.0) MIT license (LICENSE-MIT or 3 | http://opensource.org/licenses/MIT) at your option. 4 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in all 11 | copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 19 | SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Shorebird (un)installer 2 | 3 | Installation instructions are available at https://docs.shorebird.dev. 4 | 5 | ## Contributing 6 | 7 | If you're interested in contributing, please join us on 8 | [Discord](https://discord.gg/9hKJcWGcaB). 9 | 10 | ## License 11 | 12 | Shorebird projects are licensed for use under either Apache License, Version 2.0 13 | (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) MIT license 14 | (LICENSE-MIT or http://opensource.org/licenses/MIT) at your option. 15 | 16 | See our license philosophy for more information on why we license files this 17 | way: 18 | https://github.com/shorebirdtech/handbook/blob/main/engineering.md#licensing-philosophy 19 | -------------------------------------------------------------------------------- /install.ps1: -------------------------------------------------------------------------------- 1 | $ErrorActionPreference = "Stop" 2 | 3 | $installDirectory = [IO.Path]::Combine($home, ".shorebird") 4 | 5 | function Test-GitInstalled { 6 | if (Get-Command git -ErrorAction SilentlyContinue) { 7 | Write-Debug "Git is installed." 8 | } 9 | else { 10 | Write-Output "No git installation detected. Git is required to use shorebird." 11 | exit 1 12 | } 13 | } 14 | 15 | function Compare-GitVersions { 16 | param ( 17 | [string]$version1, 18 | [string]$version2 19 | ) 20 | 21 | $version1Components = $version1 -split '\.' 22 | $version2Components = $version2 -split '\.' 23 | 24 | for ($i = 0; $i -lt 3; $i++) { 25 | $version1Number = [int]$version1Components[$i] 26 | $version2Number = [int]$version2Components[$i] 27 | 28 | if ($version1Number -lt $version2Number) { 29 | return -1 30 | } 31 | elseif ($version1Number -gt $version2Number) { 32 | return 1 33 | } 34 | } 35 | 36 | return 0 37 | } 38 | 39 | function Test-GitVersion { 40 | $minGitVersion = "2.25.1" 41 | $gitVersion = (Get-Item (Get-Command git).Source).VersionInfo.ProductVersionRaw 42 | $comparisonResult = Compare-GitVersions -version1 $gitVersion -version2 $minGitVersion 43 | if ($comparisonResult -eq -1) { 44 | Write-Output "Installed git version $gitVersion is older than required git version $minGitVersion." 45 | exit 1 46 | } 47 | } 48 | 49 | function Update-Path { 50 | $path = [Environment]::GetEnvironmentVariable("PATH", "User") 51 | if ($path.contains($installDirectory)) { 52 | return $false 53 | } 54 | $binPath = [IO.Path]::Combine($installDirectory, "bin") 55 | [Environment]::SetEnvironmentVariable( 56 | "Path", $path + [IO.Path]::PathSeparator + $binPath, "User" 57 | ) 58 | 59 | return $true 60 | } 61 | 62 | Test-GitInstalled 63 | Test-GitVersion 64 | 65 | $force = $args -contains "--force" 66 | 67 | if (Test-Path $installDirectory) { 68 | if ($force) { 69 | Write-Output "Existing Shorebird installation detected. Overwriting..." 70 | Remove-Item -Recurse -Force $installDirectory 71 | } 72 | else { 73 | Write-Output "Error: Existing Shorebird installation detected. Use --force to overwrite." 74 | return 75 | } 76 | } 77 | 78 | Write-Output "Installing Shorebird to $installDirectory..." 79 | 80 | & git clone https://github.com/shorebirdtech/shorebird.git -b stable $installDirectory 81 | 82 | Push-Location $installDirectory\bin 83 | & .\shorebird.ps1 --version 84 | Pop-Location 85 | 86 | $wasPathUpdated = Update-Path 87 | # 1F426 is the code for 🐦. See https://unicode.org/emoji/charts/full-emoji-list.html#1f426. 88 | $birdEmoji = [System.Char]::ConvertFromUtf32([System.Convert]::toInt32("1F426", 16)) 89 | 90 | Write-Output @" 91 | 92 | $birdEmoji Shorebird has been installed! 93 | 94 | "@ 95 | 96 | if ($wasPathUpdated) { 97 | Write-Output @" 98 | Please restart your terminal to start using Shorebird. 99 | "@ 100 | } 101 | 102 | Write-Output @" 103 | To create an account, visit: https://console.shorebird.dev 104 | Then login using: 105 | 106 | shorebird login 107 | 108 | For more information, visit: 109 | https://docs.shorebird.dev 110 | "@ 111 | -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | set -e 4 | 5 | install_dir() { 6 | [ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.shorebird" || printf %s "${XDG_CONFIG_HOME}/shorebird" 7 | } 8 | 9 | add_shorebird_to_path() { 10 | # Add the Shorebird CLI to your PATH. 11 | echo "Adding Shorebird to your PATH" 12 | 13 | rc_files=("$HOME/.bashrc" "$HOME/.zshrc") 14 | for rc_file in ${rc_files[@]}; do 15 | if [[ -e "$rc_file" ]]; then 16 | found_rc_file=true 17 | echo "Updating $rc_file" 18 | echo "export PATH=\"$(install_dir)/bin:\$PATH\"" >>$rc_file 19 | fi 20 | done 21 | 22 | if [[ ! $found_rc_file ]]; then 23 | echo "Unable to determine shell type. Please add Shorebird to your PATH manually." 24 | echo "export PATH=\"$(install_dir)/bin:\$PATH\"" 25 | fi 26 | } 27 | 28 | # Function to compare two major.minor.patch versions 29 | # Returns: 30 | # 0 - If version1 is equal to version2 31 | # 1 - If version1 is older than version2 32 | # 2 - If version1 is newer than version2 33 | # With help from copilot :) 34 | version_compare () { 35 | # Get the two versions as arguments 36 | local version1=$1 37 | local version2=$2 38 | 39 | # Split the versions into their major, minor, and patch components 40 | local major1=${version1%%.*} 41 | local minor1=${version1#*.} 42 | minor1=${minor1%%.*} 43 | local patch1=${version1##*.} 44 | 45 | local major2=${version2%%.*} 46 | local minor2=${version2#*.} 47 | minor2=${minor2%%.*} 48 | local patch2=${version2##*.} 49 | 50 | # Compare major versions 51 | if [ "$major1" -lt "$major2" ]; then 52 | return 1 53 | elif [ "$major1" -gt "$major2" ]; then 54 | return 2 55 | else 56 | # Major versions are the same, compare minor versions 57 | if [ "$minor1" -lt "$minor2" ]; then 58 | return 1 59 | elif [ "$minor1" -gt "$minor2" ]; then 60 | return 2 61 | else 62 | # Minor versions are the same, compare patch versions 63 | if [ "$patch1" -lt "$patch2" ]; then 64 | return 1 65 | elif [ "$patch1" -gt "$patch2" ]; then 66 | return 2 67 | else 68 | # Patch versions are the same 69 | return 0 70 | fi 71 | fi 72 | fi 73 | } 74 | 75 | FORCE=false 76 | if [[ "$*" == *"--force"* ]]; then 77 | FORCE=true 78 | fi 79 | 80 | # Test if Git is available on the Host 81 | if ! hash git 2>/dev/null; then 82 | echo >&2 "Error: Unable to find git in your PATH." 83 | exit 1 84 | fi 85 | 86 | MIN_GIT_VERSION="2.25.1" 87 | GIT_VERSION=$(git --version | awk '{print $3}') 88 | set +e 89 | version_compare "$MIN_GIT_VERSION" "$GIT_VERSION" 90 | GIT_VERSION_COMPARISON=$? 91 | set -e 92 | if [ $GIT_VERSION_COMPARISON -eq 2 ]; then 93 | echo >&2 "Error: system git version ($GIT_VERSION) is older than required ($MIN_GIT_VERSION)." 94 | exit 1 95 | fi 96 | 97 | # Check if install_dir already exists 98 | if [ -d "$(install_dir)" ]; then 99 | if [ "$FORCE" = true ]; then 100 | echo "Existing Shorebird installation detected. Overwriting..." 101 | rm -rf "$(install_dir)" 102 | else 103 | echo >&2 "Error: Existing Shorebird installation detected. Use --force to overwrite." 104 | exit 1 105 | fi 106 | fi 107 | 108 | # Clone the Shorebird repository into the install_dir 109 | echo "Cloning Shorebird into $(install_dir)" 110 | git clone https://github.com/shorebirdtech/shorebird.git -b stable "$(install_dir)" 111 | 112 | # Build Shorebird 113 | (cd "$(install_dir)" && ./bin/shorebird --version) 114 | 115 | RELOAD_REQUIRED=false 116 | SHOREBIRD_BIN="$(install_dir)/bin" 117 | case :$PATH: in *:$SHOREBIRD_BIN:*) ;; # do nothing, it's there 118 | *) 119 | RELOAD_REQUIRED=true 120 | add_shorebird_to_path >&2 121 | ;; 122 | esac 123 | 124 | echo "" 125 | echo "🐦 Shorebird has been installed!" 126 | 127 | if [ "$RELOAD_REQUIRED" = true ]; then 128 | echo " 129 | Close and reopen your terminal to start using Shorebird or run the following command to start using it now: 130 | 131 | export PATH=\"$(install_dir)/bin:\$PATH\"" 132 | fi 133 | 134 | echo " 135 | To create an account, visit: https://console.shorebird.dev 136 | Then login using: 137 | 138 | shorebird login 139 | 140 | For more information, visit: 141 | https://docs.shorebird.dev 142 | " 143 | --------------------------------------------------------------------------------