Skip to main content
Before you can use the Checkly CLI, you need to authenticate with your Checkly account. There are different ways to authenticate depending on the environment where you are running the CLI from.

Interactive

When running the CLI interactively from your dev environment, just use the built-in login command. It shows a URL and a code that you can open in a browser on any device, so it also works over SSH and from AI agents. If you have multiple Checkly accounts, it will prompt which account you want to target.
Terminal
Once authenticated, you can switch between accounts using:
Terminal
… or quickly find out which account you are currently targeting with:
Terminal
To log out and clear your stored credentials:
Terminal

From CI

You can also authenticate using environment variables, which is useful for CI/CD pipelines and automated environments. You will need to export two environment variables in the shell:
  • CHECKLY_API_KEY
  • CHECKLY_ACCOUNT_ID
To get your API key, go to your Settings page in Checkly and grab a API key from the API keys tab and your Account ID from the Account settings tab. Set the account ID and API key as follows:
Terminal
To verify you’re properly authenticated:
Terminal
This will display your account information and confirm your authentication status.

Troubleshooting

npx checkly login prints the login URL and a code. If no browser window opens, open the URL in a browser on any device and enter the code.