Account CLI Reference

The Shorebird CLI provides several commands to help you manage your authentication state, inspect your account details, and manage your apps and organizations directly from the terminal.

Authentication commands

Login

To authenticate with Shorebird on your machine, run:

shorebird login

This command will prompt you to visit a URL in your browser to complete the OAuth login process. Once authenticated, your session credentials are saved securely on your machine, allowing you to use shorebird commands without needing to re-authenticate.

Logout

To log out of the current Shorebird user session and remove stored credentials from your machine, run:

shorebird logout

Account management commands

The shorebird account command provides several subcommands to inspect your account details, apps, and organizations.

Current account

To see the currently authenticated user’s details, run:

shorebird account whoami

Example output:

ID:             42
Email:          user@example.com
Display name:   Example User
Plan:           paid
Overage limit:  10000

This command is useful for verifying which account you are logged into and checking your current billing plan and patch overage limit.

List apps

To list all the Shorebird apps that your current account has access to, run:

shorebird account apps

Example output:

01H...  Acme Mobile  1.2.3  4
01J...  Acme Internal  -  -

The output displays the App ID, display name, latest release version, and latest patch number (with - indicating no release or patch has been published yet).

List organizations

To list all the organizations you belong to, run:

shorebird account orgs

Example output:

1  Acme Corp  team  admin
2  user@example.com  personal  owner

This output displays the Organization ID, name, organization type (personal or team), and your membership role (owner, admin, or developer).

App management commands

As of Shorebird 1.6.121, the shorebird apps commands list, rename, delete, and transfer your apps. shorebird apps list shows the same output as shorebird account apps.

rename, delete, and transfer act on the app in shorebird.yaml in the current directory. Pass --app-id to pick a different app or to run the command from outside a Shorebird project. If your app uses flavors, pass --flavor to pick that flavor’s app ID.

Rename an app

To change an app’s display name, which can be up to 128 characters, run:

shorebird apps rename --name "Acme Consumer"

Example output:

Renamed "Acme Mobile" to "Acme Consumer".

Transfer an app

To move an app into another organization, pass the organization’s ID. Run shorebird account orgs to find it:

shorebird apps transfer --org-id 42

Example output:

Moved "Acme Mobile" into "Acme Corp".

You must be a member of the target organization, and have permission to move apps out of the app’s current organization and into the target one. See Organizations for more on transferring apps.

Delete an app

Deleting an app permanently deletes every release and patch that belongs to it, and can’t be undone. Read Delete Apps, Releases, and Patches before you do this.

There’s no confirmation prompt. Instead, you confirm by passing the app’s current display name, exactly as shorebird apps list shows it, to --confirm-name:

shorebird apps delete --confirm-name "Acme Mobile"

Example output:

Deleted "Acme Mobile" (01H...).

If the name doesn’t match, nothing is deleted and the command prints the name it expected.

---

JSON output for automation

All shorebird account and shorebird apps subcommands support the --json flag, making them easy to integrate into scripts and automation workflows.

shorebird account whoami --json
shorebird account apps --json
shorebird account orgs --json
shorebird apps list --json

When using --json, the CLI will output a structured JSON response instead of human-readable text.