Skip to main content

Getting started with the API/CLI

Run this in the terminal to globally install the CLI:

npm install -g debugbear

Or if you are using the Node API, install debugbear in your local node_modules:

npm install debugbear --save-dev

Generating an API key​

Project API keys​

Use a project API key to trigger page tests, for example as part of your CI process.

You can generate an key in the API keys tab of your project dashboard.

Generate API key button in the API keys tab

Admin API keys​

Use an admin API key to set up pages for monitoring and manage projects.

You can generate an Admin API key in your account settings. You need to be an admin for this organization to be able to generate the key.

Admin API tab in account settings

Finding the page ID​

To identify the page you want to test you need to pass in a pageId argument.

You can find this ID in the left sidebar of the Edit Page screen.

page id next to the page edit button

Now you can use the API/CLI​

Check out the CLI docs, or the API docs.