feat(shorebird_cli): shorebird init (#72)
This commit is contained in:
@@ -14,9 +14,37 @@ dart pub global activate --source git https://github.com/shorebirdtech/shorebird
|
||||
|
||||
## Commands
|
||||
|
||||
### Init
|
||||
|
||||
Get started by initializing shorebird in your current project.
|
||||
|
||||
```bash
|
||||
shorebird init
|
||||
```
|
||||
|
||||
**Sample**
|
||||
|
||||
```
|
||||
shorebird init
|
||||
✓ Initialized Shorebird (27ms)
|
||||
|
||||
🐦 Shorebird initialized successfully!
|
||||
|
||||
✅ 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 build your project use: "shorebird build".
|
||||
🚀 To publish a new update use: "shorebird publish".
|
||||
|
||||
For more information, visit https://shorebird.dev
|
||||
```
|
||||
|
||||
### Login
|
||||
|
||||
Get started by requesting an API key and using `shorebird login` to authenticate:
|
||||
Request an API key and use `shorebird login` to authenticate:
|
||||
|
||||
```bash
|
||||
shorebird login
|
||||
@@ -24,7 +52,7 @@ shorebird login
|
||||
|
||||
**Sample**
|
||||
|
||||
```bash
|
||||
```
|
||||
shorebird login
|
||||
? Please enter your API Key: <API-KEY>
|
||||
✓ Logging into shorebird.dev (7ms)
|
||||
@@ -41,11 +69,27 @@ shorebird logout
|
||||
|
||||
**Sample**
|
||||
|
||||
```bash
|
||||
```
|
||||
shorebird logout
|
||||
✓ Logging out of shorebird.dev (1ms)
|
||||
```
|
||||
|
||||
### List Apps
|
||||
|
||||
List all existing apps in Shorebird using the `shorebird apps list` command:
|
||||
|
||||
```bash
|
||||
shorebird apps list
|
||||
```
|
||||
|
||||
**Sample**
|
||||
|
||||
```
|
||||
shorebird apps list
|
||||
my-counter: v1.0.0 (patch #1)
|
||||
my-example: v2.1.0 (patch #2)
|
||||
```
|
||||
|
||||
### Run
|
||||
|
||||
Run an existing application using the Shorebird Engine via the `shorebird run` command:
|
||||
@@ -54,7 +98,7 @@ Run an existing application using the Shorebird Engine via the `shorebird run` c
|
||||
shorebird run
|
||||
```
|
||||
|
||||
**❗️Note**: If it's the first time, `shorebird run` will download and build the shorebird engine which may take some time. The shorebird engine will be cached for subsequent runs.
|
||||
**❗️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.
|
||||
|
||||
### Build
|
||||
|
||||
@@ -64,6 +108,8 @@ Build a new release of your application using the `shorebird build` command:
|
||||
shorebird build
|
||||
```
|
||||
|
||||
**❗️Note**: If it's the first time using shorebird, `shorebird build` will download and build the shorebird engine which may take some time. The shorebird engine will be cached for subsequent runs.
|
||||
|
||||
### Publish
|
||||
|
||||
The publish command allows developers to publish new releases of their Flutter application to the Shorebird CodePush API. These updates are then pushed directly to users' devices.
|
||||
@@ -89,7 +135,9 @@ Global options:
|
||||
--[no-]verbose Noisy logging, including all shell commands executed.
|
||||
|
||||
Available commands:
|
||||
apps Manage your Shorebird apps.
|
||||
build Build a new release of your application.
|
||||
init Initialize Shorebird.
|
||||
login Login as a new Shorebird user.
|
||||
logout Logout of the current Shorebird user
|
||||
publish Publish an update.
|
||||
|
||||
Reference in New Issue
Block a user