Quick start guide

5 min readLast updated 2026-04-20

Get your first test running in under 10 minutes. Install the CLI, authenticate, and run a sample test suite.

Check Studio is designed to get you from zero to passing tests in under 10 minutes. This guide walks you through installation, authentication, and your first test run.

Prerequisites

  • Node.js 18 or later
  • A GitHub, GitLab, or Bitbucket account
  • A project with a frontend or API to test

Step 1: Install the CLI

1

Install globally via npm

Run the install command to get the Check Studio CLI on your machine.

npm install -g @checkstudio/cli
bash

Step 2: Authenticate

2

Log in to your workspace

The login command opens a browser window for secure OAuth authentication.

checkstudio login
bash

Step 3: Initialize a project

3

Run init in your repo

This creates a checkstudio.config.js and a sample tests directory.

checkstudio init
bash

Step 4: Run your first test

4

Execute the sample suite

The default suite includes a smoke test against your local dev server.

checkstudio run
bash

Tip

Use --watch mode during development to get instant feedback on test changes: checkstudio run --watch

Next steps

Now that your first test passes, explore the Visual Builder for no-code test authoring, or dive into Playwright test templates for code-first workflows.

Was this article helpful?

Still have questions?

Our support team is here to help. Reach out directly or search the docs.