Skip to main content
The Revyl CLI uses API keys for authentication. You can authenticate interactively or use environment variables for CI/CD.

​
Getting an API Key

  1. In the Revyl dashboard, go to Settings → API Keys
  2. Click Create API Key (or New API key)
  3. Name your key (e.g. local-dev, github-actions) and pick an expiration
  4. Click Create and copy the key — it’s only shown once
API keys are only shown once. Store it securely - you’ll need it for the next step.

​
Interactive Login

The simplest way to authenticate:
You’ll be prompted to enter your API key:
The CLI validates your key against the API and stores it locally.

​
Check Authentication Status

Verify your current authentication:
Output:

​
Logout

Remove stored credentials:

​
Environment Variable (CI/CD)

For CI/CD pipelines, use the REVYL_API_KEY environment variable instead of interactive login:
By default the environment variable takes precedence over stored credentials.

​
Overriding with Browser Login

If REVYL_API_KEY is set in your shell but you need to use a different account locally, run revyl auth login. The browser login will become the active credential for all subsequent interactive CLI commands, even while the env var remains set. This override persists across commands (revyl dev, revyl build, etc.) until you explicitly log out or log in with a different method. CI/non-interactive environments that only set REVYL_API_KEY without a prior browser login are unaffected.

​
GitHub Actions Example

​
GitLab CI Example

​
Credential Storage

When you run revyl auth login, credentials are stored in:
This file contains your API key and is automatically excluded from version control by the CLI’s .gitignore template.
Never commit API keys to version control. Use environment variables or secrets management for CI/CD.

​
Troubleshooting

​
”Invalid API key” Error

  • Verify the key hasn’t expired in the Revyl dashboard
  • Check for extra whitespace when copying the key
  • Ensure you’re using the correct organization’s key

​
”Network error” During Login

  • Check your internet connection
  • Verify api.revyl.ai is accessible from your network
  • Try revyl ping to test connectivity

​
Credentials Not Persisting

  • Check write permissions for ~/.revyl/
  • Ensure the directory exists: mkdir -p ~/.revyl

​
”Org mismatch” After Switching Accounts

If you see an org mismatch error after revyl init or revyl dev:
  1. Run revyl auth login to perform a browser login with the correct account
  2. The browser login will override REVYL_API_KEY for local commands
  3. Re-run revyl init --force to rebind the project to the new account