Skip to main content

Usage

elizaos login [options]
Authenticate with ElizaOS Cloud using browser-based OAuth flow. On successful authentication, your API key is stored locally for use with other commands.

Options

OptionDescriptionDefault
-u, --cloud-url <url>URL of ElizaOS Cloudhttps://www.elizacloud.ai
--no-browserDo not automatically open browserfalse
--timeout <seconds>Authentication timeout in seconds300

Examples

Basic Login

# Login with browser (default)
elizaos login

# The command will:
# 1. Open your browser to the ElizaOS Cloud login page
# 2. Wait for you to complete authentication
# 3. Store the API key locally

Without Browser

# Login without auto-opening browser
elizaos login --no-browser

# The command will display a URL to visit manually

Custom Cloud Instance

# Login to a custom ElizaOS Cloud instance
elizaos login --cloud-url https://custom.elizacloud.ai

Extended Timeout

# Allow more time for authentication (10 minutes)
elizaos login --timeout 600

Authentication Flow

  1. Start: CLI initiates authentication request
  2. Browser: Opens login page (or displays URL if --no-browser)
  3. Authenticate: Complete login in browser (OAuth/credentials)
  4. Callback: Browser sends token back to CLI
  5. Store: API key is stored in ~/.elizaos/credentials

Environment Variable

Instead of logging in, you can set the API key directly:
export ELIZA_CLOUD_API_KEY=your-api-key
Or use the ELIZA_CLOUD_URL environment variable:
export ELIZA_CLOUD_URL=https://custom.elizacloud.ai
elizaos login

Credential Storage

After successful login, credentials are stored at:
  • Linux/macOS: ~/.elizaos/credentials
  • Windows: %USERPROFILE%\.elizaos\credentials

Troubleshooting

Browser Doesn’t Open

# Use --no-browser and copy the URL manually
elizaos login --no-browser

Timeout Issues

# Increase timeout for slow connections
elizaos login --timeout 600

Network Issues

If behind a proxy or firewall, ensure the cloud URL is accessible:
# Test connectivity
curl https://www.elizacloud.ai/health

# Then login
elizaos login
  • deploy: Deploy after authentication
  • containers: Manage containers (requires auth)