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. Go to Account → Personal API Keys in Revyl
  2. Click New API key
  3. Select an expiration period (recommended: 1 year for development)
  4. Click Create and copy the key
API keys are only shown once. Store it securely - you’ll need it for the next step.

​
Interactive Login

The simplest way to authenticate: 
revyl auth login
You’ll be prompted to enter your API key: 
Enter your API key: rvl_xxxxxxxxxxxxxxxxxxxx
✓ Authenticated as [email protected]
✓ Organization: My Company
✓ Credentials saved to ~/.revyl/credentials.json
The CLI validates your key against the API and stores it locally.

​
Check Authentication Status

Verify your current authentication: 
revyl auth status
Output: 
✓ Authenticated
  Email: [email protected]
  User ID: usr_abc123
  Org ID: org_xyz789
  API Key: rvl_xxxx...xxxx (masked)

​
Logout

Remove stored credentials: 
revyl auth logout

​
Environment Variable (CI/CD)

For CI/CD pipelines, use the REVYL_API_KEY environment variable instead of interactive login: 
export REVYL_API_KEY=rvl_your_api_key_here
The environment variable takes precedence over stored credentials.

​
GitHub Actions Example

- name: Run Revyl Tests
  env:
    REVYL_API_KEY: ${{ secrets.REVYL_API_KEY }}
  run: |
    revyl workflow run smoke-tests

​
GitLab CI Example

test:
  script:
    - revyl workflow run smoke-tests
  variables:
    REVYL_API_KEY: $REVYL_API_KEY

​
Credential Storage

When you run revyl auth login, credentials are stored in: 
~/.revyl/credentials.json
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

​
Next Steps

Project Setup

Initialize your project

CI/CD Integration

Set up automated testing