Authenticating with the Payments Wallet
When the wallet is not signed in (detected via npx awal status or when wallet operations fail with authentication errors), use the npx awal CLI to authenticate.
If you have access to email, you can authenticate the wallet yourself, otherwise you'll need to ask your human to give you an email address and to tell you the OTP code they receive.
Authentication Flow
Authentication uses a two-step email OTP process:
Step 1: Initiate login
npx awal@latest auth login <email>
This sends a 6-digit verification code to the email and outputs a flowId.
Step 2: Verify OTP
npx awal@latest auth verify <flowId> <otp>
Use the flowId from step 1 and the 6-digit code from the user's email to complete authentication. If you have the ability to access the user's email, you can read the OTP code, or you can ask your human for the code.
Checking Authentication Status
npx awal@latest status
Displays wallet server health and authentication status including wallet address.
Example Session
# Check current status
npx awal@latest status
# Start login (sends OTP to email)
npx awal@latest auth login [email protected]
# Output: flowId: abc123...
# After user receives code, verify
npx awal@latest auth verify abc123 123456
# Confirm authentication
npx awal@latest status
Available CLI Commands
| Command | Purpose |
|---|
npx awal@latest status | Check server health and auth status |
npx awal@latest auth login <email> | Send OTP code to email, returns flowId |
npx awal@latest auth verify <flowId> <otp> | Complete authentication with OTP code |
npx awal@latest balance | Get USDC wallet balance |
npx awal@latest address | Get wallet address |
npx awal@latest show | Open the wallet companion window |
JSON Output
All commands support --json for machine-readable output:
npx awal@latest status --json
npx awal@latest auth login [email protected] --json
npx awal@latest auth verify <flowId> <otp> --json