# Quickstart

Source: https://docs.qualflare.com/docs/get-started · Last updated: 2026-10-28

Get started with Qualflare in minutes: create your first test case, install the qf CLI, upload a test results file and open the launch it creates.

To get started with Qualflare, create your first test case in the web app and upload your first test results file with the `qf` CLI (version 0.4.0); you need the Editor role or higher in the project.

## Before you begin

You need:

* A Qualflare account. Sign up at [qualflare.com](https://qualflare.com).
* A workspace and a project, created during the onboarding flow after sign-up.
* A project role that can create cases and access tokens (requires the Editor role or higher in the project)
* Tests that write a results file `qf` reads: 27 frameworks and 4 generic formats. See [Collect Test Results](https://docs.qualflare.com/docs/cli/collect).

## Create your first test case

Test cases are the individual tests you want to run. You create a case inside a suite, then add its steps.

### Step 1: Create a suite

In your project, click **Browse** in the left sidebar. A new project has no suites yet, so click **Create Suite** first.

*Figure: A new project starts with no suites, so create a suite before your first case.*

### Step 2: Create a case

Click the suite's name and open its **Test Cases** tab. Click **Create Case**, enter a **Name** (for example, "User login with valid credentials") and click **Create**. The dialog saves only the name.

*Figure: The Create Case dialog saves only the name; set the other fields on the case afterwards.*

To set the description and priority, see [Creating Test Cases](https://docs.qualflare.com/docs/test-management/create-test-cases).

### Step 3: Add steps

Open the case and go to its **Steps** tab. Click **Create Step**, enter the **Step Instructions**, pick a **Type** and click **Create**. Repeat for each step. Write what should happen if the test passes as a step of type **Expected Result**.

*Figure: Record what a passing test shows as a step of type Expected Result.*

## Upload test results with the CLI

The Qualflare CLI (`qf`) collects test results from 27 frameworks and 4 generic formats and uploads them to your project.

### Step 1: Install the qf CLI

**Homebrew:**

```bash
brew install qualflare/tap/qf
```

**npm:**

```bash
npm install -g @qualflare/cli
```

**Docker:**

```bash
docker run --rm ghcr.io/qualflare/qf:0.4.0 version
```

**Binary:**

```bash
# Download a binary for your platform from the qf 0.4.0 release page:
# https://github.com/Qualflare/qualflare-cli/releases/tag/v0.4.0
```

Download a binary from the [qf 0.4.0 release page](https://github.com/Qualflare/qualflare-cli/releases/tag/v0.4.0).

To upgrade later, see [Install Qualflare CLI](https://docs.qualflare.com/docs/cli/installation#upgrading).

### Step 2: Run your tests

Run your tests with your preferred framework, and have it write a results file:

```bash
# pytest: writes JUnit XML to results.xml
pytest tests/ --junitxml=results.xml

# Jest: writes Jest's JSON report to results.json
npx jest --ci --json --outputFile=results.json
```

### Step 3: Create an access token

In your project, open **Settings** > **Access Tokens** and click **Create Access Token**. Copy the token: it is shown only once.

A token that only uploads results doesn't need **Allow writes**; see [Access Tokens](https://docs.qualflare.com/docs/api/access-tokens).

*Figure: A token that only uploads test results doesn't need Allow writes.*

### Step 4: Log in and upload

Save the token under a short local name. `qf` asks for the token and hides what you type:

```bash
qf login myapp
```

Then upload your results file:

```bash
qf myapp collect results.xml   # or results.json from the Jest example
```

The CLI will:

* Detect the test framework automatically
* Parse the results file
* Upload results to your Qualflare project
* Create a new **launch** with the results

For CI setup, see [Authentication](https://docs.qualflare.com/docs/cli/authentication).

## Verify

Open **Launches** in the project sidebar and click the launch you created. You should see its overall pass and fail status, each test case's result, and failure details with stack traces.

*Figure: Each upload creates a launch, listed under Launches.*

*Figure: Open a launch to see its pass and fail counts, each test's result and failure details.*

## Troubleshoot

* `qf` doesn't install: see [CLI Installation Fails](https://docs.qualflare.com/docs/cli/troubleshooting#installation-fails).
* The token is rejected: see [API Key Not Working](https://docs.qualflare.com/docs/cli/troubleshooting#api-key-not-working).
* The upload fails: see [CLI Upload Command Fails](https://docs.qualflare.com/docs/cli/troubleshooting#upload-command-fails).
* `qf` can't tell the format of your results file: see [CLI Format Not Detected](https://docs.qualflare.com/docs/cli/troubleshooting#format-not-detected).
* No launch appears: see [Results Not Appearing](https://docs.qualflare.com/docs/faq/troubleshooting#results-not-appearing).

## Next steps

* [CI/CD Integration](https://docs.qualflare.com/docs/cli/ci-cd): upload results from your CI pipeline
* [Search, filters and shortcuts](https://docs.qualflare.com/docs/get-started/search-and-filters): find test cases, launches and defects, and every keyboard shortcut
* [Core Concepts](https://docs.qualflare.com/docs/get-started/core-concepts): workspaces, projects, test cases, launches and the other entities
* [Run tests: manual and automated](https://docs.qualflare.com/docs/runs): run cases by hand or upload results from CI

See also: [FAQ](https://docs.qualflare.com/docs/faq) · [Troubleshooting](https://docs.qualflare.com/docs/faq/troubleshooting)