flutter/shorebird
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

chore: Redirect users to docs.shorebird.dev (#391)

Browse Source
This commit is contained in:
Eric Seidel
2023-04-27 11:25:12 -04:00
committed by GitHub
parent 155a1cd6a5
commit 36a6f117cb
1 changed files with 4 additions and 413 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/shorebird_cli/README.md
+4 -413
View File
@@ -1,418 +1,9 @@
# Shorebird CLI
**🚧 This project is under heavy development 🚧**
The Shorebird command-line allows developers to interact with various Shorebird services.
**❗️ Currently, only Android release builds are supported but we are working on expanding to other platforms/architectures.**
See https://docs.shorebird.dev for more information.
The Shorebird command-line allows developers to interact with various Shorebird services. We're currently focusing on CodePush but the Shorebird CLI will continue to expand as we add more capabilities.
`shorebird help` shows high-level help on available commands.
## Installing
```
curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/shorebirdtech/install/main/install.sh -sSf | sh
```
## Commands
### Init
Get started by initializing shorebird in your current project.
```bash
# 1. Creates a new app (if one doesn't exist) with a stable channel.
# 2. Generates a shorebird.yaml (if one doesn't exist).
# 3. Adds the shorebird.yaml to the pubspec.yaml flutter assets.
shorebird init
```
**Sample**
```
shorebird init
✓ Initialized Shorebird (27ms)
🐦 Shorebird initialized successfully!
✅ A shorebird app has been created.
✅ A "shorebird.yaml" has been created.
✅ The "pubspec.yaml" has been updated to include "shorebird.yaml" as an asset.
Reference the following commands to get started:
🚙 To run your project use: "shorebird run".
📦 To create a new release use: "shorebird release".
🚀 To push a new update use: "shorebird patch".
For more information, visit https://shorebird.dev
```
### Login
Request an API key and use `shorebird login` to authenticate:
```bash
shorebird login
```
**Sample**
```
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".
```
### Logout
To sign out and remove an existing session, use the `shorebird logout` command:
```bash
shorebird logout
```
**Sample**
```
shorebird logout
✓ Logging out of shorebird.dev (1ms)
```
### Create Account
To create a new Shorebird account use the `shorebird account create` command:
```bash
shorebird account create
```
**Sample**
```
$ shorebird account create
Shorebird currently requires a Google account for authentication. If you'd like to use a different kind of auth, please let us know: https://github.com/shorebirdtech/shorebird/issues/335.
Follow the link below to authenticate:
https://accounts.google.com/o/oauth2/v2/auth...
Waiting for your authorization...
Tell us your name to finish creating your account: Jane Doe
🎉 Welcome to Shorebird, Jane Doe!
🔑 Credentials are stored in ./path/to/credentials.json.
🚪 To logout, use: "shorebird logout".
⬆️ To upgrade your account, use: "shorebird account subscribe".
Enjoy! Please let us know via Discord if we can help.
```
### Upgrade to Paid Account
To use Shorebird, you must upgrade to a paid account using the `shorebird account subscribe` command. Once you have paid, your account will be automatically upgraded and you will be able to use Shorebird to build and deploy apps.
**Sample**
```
$ shorebird account subscribe
✓ Link generated! (0.8s)
To purchase a Shorebird subscription, please visit the following link:
https://buy.stripe.com/...
Once Stripe has processed your payment, you will be able to use Shorebird to create and publish apps.
Note: This payment link is specifically for your account. Do not share it with others.
```
### Doctor
To check your environment for common issues, use the `shorebird doctor` command.
```bash
shorebird doctor
```
**Sample**
```
$ shorebird doctor
Shorebird v0.0.8
Shorebird Engine • revision d470ae25d21f583abe128f7b838476afd5e45bde
✓ Shorebird is up-to-date (0.7s)
✓ Flutter install is correct (0.1s)
✓ AndroidManifest.xml files contain INTERNET permission (26ms)
No issues detected!
```
### Create App
To create an app use the `shorebird apps create` command. An app id can be specified as a CLI option but shorebird will default to the `app_id` defined in the `shorebird.yaml`
```bash
# Create an app using default app id
shorebird apps create
# Create an app using an explicit app id
shorebird apps create --app-id "my-app-id"
```
**Sample**
```
shorebird apps create
? Enter the App ID (default_id) my_app_id
Created new app: my_app_id
```
### Delete App
To delete an existing app on Shorebird, use the `shorebird apps delete` command. An app-id can be specified as a CLI option but shorebird will default to the app_id defined in the `shorebird.yaml`
```bash
# Create an app using default app id
shorebird apps delete
# Create an app using an explicit app id
shorebird apps delete --app-id "my-app-id"
```
**Sample**
```
shorebird apps delete
? Enter the App ID (default_id) my_app_id
Deleting an app is permanent. Continue? (y/N) Yes
Deleted app: my_app_id
```
### List Apps
List all existing apps in Shorebird using the `shorebird apps list` command:
```bash
shorebird apps list
```
**Sample**
```
shorebird apps list
📱 Apps
┌───────────────────┬──────────────────────────────────────┬─────────┬───────┐
│ Name │ ID │ Release │ Patch │
├───────────────────┼──────────────────────────────────────┼─────────┼───────┤
│ Shorebird Counter │ 30370f27-dbf1-4673-8b20-fb096e38dffa │ 1.0.0 │ 1 │
├───────────────────┼──────────────────────────────────────┼─────────┼───────┤
│ Shorebird Clock │ 05b45471-a5f3-48cd-b26a-da29d95914a7 │ -- │ -- │
└───────────────────┴──────────────────────────────────────┴─────────┴───────┘
```
### Run
Run an existing application using the Shorebird Engine via the `shorebird run` command:
```bash
shorebird run
```
**❗️Note**: If it's the first time using shorebird, `shorebird run` will download and build the shorebird engine which may take some time. The shorebird engine will be cached for subsequent runs.
### Release
Builds and submits your app to Shorebird. Shorebird saves the compiled Dart code from your application in order to make smaller updates to your app.
```bash
# 1. Generate a release build.
# 2. Create a release in Shorebird
# 3. Upload the release artifact to Shorebird.
shorebird release
```
**Sample**
```
$ shorebird release
✓ Building release (5.1s)
✓ Fetching apps (0.2s)
What is the version of this release? (1.0.0) 1.0.0
🚀 Ready to create a new release!
📱 App: My App (30370f27-dbf1-4673-8b20-fb096e38dffa)
📦 Release Version: 1.0.0
🕹️ Platform: android (arm64, arm32, x86)
Would you like to continue? (y/N) Yes
✓ Fetching releases (55ms)
✓ Creating release (45ms)
✓ Creating artifacts (4.6s)
✅ Published Release!
Your next step is to upload the app bundle to the Play Store.
./build/app/outputs/bundle/release/app-release.aab
See the following link for more information:
https://support.google.com/googleplay/android-developer/answer/9859152?hl=en
```
### Patch
The patch command allows developers to upload new patches (updates) of their Flutter application to the Shorebird CodePush API. These updates are then pushed directly to users' devices.
```bash
# Publish the artifacts
# 1. Builds the artifacts (equivalent to a shorebird build)
# 2. Creates a new patch if one does not exist
# 3. Uploads the artifacts as part of the patch
# 4. Promotes the patch to the "stable" channel
shorebird patch
```
**Sample**
```
shorebird patch
✓ Building patch (16.2s)
✓ Fetching apps (0.1s)
Which release is this patch for? (0.1.0) 0.1.0
🚀 Ready to publish a new patch!
📱 App: My App (61fc9c16)
📦 Release Version: 0.1.0
📺 Channel: stable
🕹️ Platform: android (arm64, arm32, x86)
Would you like to continue? (y/N) Yes
✓ Fetching release (41ms)
✓ Fetching release artifacts (43ms)
✓ Downloading release artifacts (0.2s)
✓ Creating artifacts (0.3s)
✓ Uploading artifacts (43ms)
✓ Fetching channels (40ms)
✓ Promoting patch to stable (43ms)
✅ Published Patch!
```
### Build
Build a new release of your application using the `shorebird build` command:
```bash
# Build an AppBundle
shorebird build appbundle
# Build an APK
shorebird build apk
```
### List Channels
See all available channels for your application using the `shorebird channels list` command:
```bash
shorebird channels list
```
**Sample**
```
shorebird channels list
📱 App ID: 61fc9c16-3c4a-4825-a155-9765993614aa
📺 Channels
┌─────────────┐
│ Name │
├─────────────┤
│ stable │
├─────────────┤
│ development │
└─────────────┘
```
### Create Channels
Create a new channel for your application using the `shorebird channels create` command:
```bash
shorebird channels create --name MyChannel
```
**Sample**
```
shorebird channels create --name MyChannel
🚀 Ready to create a new channel!
📱 App ID: 485df03f-f522-4242-bf3d-31c0869bacac
📺 Channel: MyChannel
Would you like to continue? (y/N) Yes
✓ Creating channel (0.2s)
✅ New Channel Created!
```
### Cancel Subscription
Cancel your Shorebird subscription using `shorebird subscription cancel` command:
```bash
shoreburd subscription cancel
```
**Sample**
```bash
$ shorebird subscription cancel
This will cancel your Shorebird subscription. Are you sure? (y/N) Yes
Your subscription has been canceled.
```
### Usage
```
The shorebird command-line tool
Usage: shorebird <command> [arguments]
Global options:
-h, --help Print this usage information.
-v, --version Print the current version.
--[no-]verbose Noisy logging, including all shell commands executed.
Available commands:
account Manage your Shorebird account.
apps Manage your Shorebird apps.
build Build a new release of your application.
cache Manage the Shorebird cache.
channels Manage the channels for your Shorebird app.
doctor Show information about the installed tooling.
init Initialize Shorebird.
login Login as a new Shorebird user.
logout Logout of the current Shorebird user
patch Publish new patches for a specific release to Shorebird.
release Builds and submits your app to Shorebird.
run Run the Flutter application.
subscription Manage your Shorebird subscription.
upgrade Upgrade your copy of Shorebird.
Run "shorebird help <command>" for more information about a command.
```
`shorebird <command> --help` can show information about a specific command.