CLI

Install

npm install -g birdcli-alpha

Authentication

You need to obtain a merchant API_KEY first to use the cli.

• Login

  birdcli login

Account

• Get Account Info

  birdcli account

• Delete API Key

  birdcli logout

Orders

• Create Order

  birdcli orders create \
    --total-value "10.99" \
    --currency "USD" \
    --line-items '[
      {
        "label": "Sun Hat",
        "type": "item",
        "value": "5.99",
        "status": "final",
        "thumbnail_url": "https://placehold.co/60x60.png"
      },
      {
        "label": "Sales Tax",
        "type": "tax",
        "value": "5.00",
        "status": "pending"
      },
      {
        "label": "Delivery",
        "type": "shipping",
        "value": "0.00",
        "status": "pending"
      }
    ]' \
    --required-shipping-fields "name,postalAddress,phone,email" \
    --required-billing-fields "name,postalAddress,phone,email"

• List Orders

  birdcli orders list

• Get Order by ID

  birdcli orders retrieve [orderID]

• Delete Order

  birdcli orders delete [orderID]

Miniprogram

• Initialize Miniprogram (creates config file)

  birdcli miniprogram init

• Create Miniprogram Preview

This command opens a screen to scan a qrcode of the miniprogram using a given URL.

birdcli miniprogram create-preview \
  --url https://miniprogram-developer.onrender.com/ \
  --name "Miniprogram Developer"

Example: w/ngrok url for localhost proxy

ngrok http 3000

  birdcli miniprogram create-preview \
    --url https://56fc-32-133-145-153.ngrok-free.app \
    --name "Miniprogram Developer"

• Create Miniprogram

  birdcli miniprogram create

• Release Miniprogram

  birdcli miniprogram publish

• Get Miniprogram by ID

  birdcli miniprogram get [appID]

• List Miniprograms

  birdcli miniprogram list

• Delete Miniprogram

  birdcli miniprogram delete <appID>

Webhooks

• Create Webhook

  birdcli webhook create --url https://www.example.com

• List Webhooks

  birdcli webhook list

• Delete Webhook

  birdcli webhook delete --id 1234567890

Events

• Get Event by ID

  birdcli events get <eventID>

• Stream Events

  birdcli events stream

Release

Development

npm install -g .

which birdcli

npm install -g birdcli-alpha

Uninstall

npm uninstall -g birdcli-alpha