bird auth signup · CLI reference

Usage

Code example

bird auth signup <email> [flags]

Description

Start a passwordless Bird signup and email a six-digit code.

Emails a six-digit code and creates no password — the same magic-link path the dashboard uses. Confirm the code with "bird auth verify-email" to sign in and receive an onboarding_ticket, then "bird auth create-org" to finish. Works for a brand-new email (creates the account) or an existing one (signs in). Signup is region-agnostic; you choose the region later, at create-org.

Build the request from the <email> argument, a JSON MagicLinkRequest body via --body-file ("-" reads stdin), or both — an inline value overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Procedure

Step 1 of 3 of "Sign up and create your first organization". Next: bird auth verify-email.

Examples

Code example

# print the body shape (no credentials needed)
bird auth signup --example

# the body it prints:

Code example

{
  "email": "alice@example.com"
}

Code example

# start signup, then confirm the emailed code
bird auth signup me@acme.com

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--response-schema	Print the fields this command returns, then exit

Name	Description
bird auth create-org	Create the first organization and workspace and mint your credential.
bird auth login	Authenticate with Bird through your browser (OAuth)
bird auth logout	Revoke the OAuth grant (if any) and remove the stored credentials file
bird auth status	Show current authentication state and validate the token against the API
bird auth verify-email	Confirm the emailed six-digit code and sign in.