# Qualflare CLI Tool

Source: https://docs.qualflare.com/docs/cli · Last updated: 2026-11-17

Upload test results from 27 frameworks and 4 generic formats with the Qualflare CLI, then query suites, cases, plans, launches and defects.

The **Qualflare CLI** (`qf`) is a command-line tool for interacting with Qualflare from your terminal or CI/CD pipeline. It parses and uploads test results from 27 frameworks and 4 generic formats, and provides read access to all your test management data.

## Features

* **Auto-detection**: Automatically detects test framework from file patterns and content
* **Multi-format support**: Parse JUnit, pytest, Go test, Jest, Playwright, Cypress, Newman, k6, and more
* **Resource queries**: List and inspect suites, cases, plans, launches, defects, clusters, and milestones
* **CI/CD integration**: Environment variables and Git metadata auto-enrichment
* **Validation**: Validate test result files before uploading
* **Dry-run mode**: Preview parsed results without uploading

## Quick Start

```bash
# Install (see Installation for details)
brew install qualflare/tap/qf

# Sign in through your browser and save it under a local identifier
qf login myapp

# Upload test results
qf myapp collect results.xml

# List test suites
qf myapp suites list
```

## Commands

### Authentication

| Command                                                                                     | Description                                                                                                                                                                                                         |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`login <identifier> [token]`](https://docs.qualflare.com/docs/cli/authentication#qf-login) | Sign in under a local project identifier. In a terminal, `qf` opens your browser (`--no-browser` for remote machines). With `[token]`, `QF_TOKEN`, piped input or `--with-token`, it saves an access token instead. |
| [`logout <identifier>`](https://docs.qualflare.com/docs/cli/authentication#qf-logout)       | Remove saved credentials for an identifier                                                                                                                                                                          |
| [`projects`](https://docs.qualflare.com/docs/cli/authentication#qf-projects)                | List all saved project identifiers                                                                                                                                                                                  |

### Data Collection

| Command                                                                             | Description                                  |
| ----------------------------------------------------------------------------------- | -------------------------------------------- |
| [`collect`](https://docs.qualflare.com/docs/cli/collect)                            | Parse and upload test results to Qualflare   |
| [`validate`](https://docs.qualflare.com/docs/cli/commands#validate-command)         | Validate test result files without uploading |
| [`list-formats`](https://docs.qualflare.com/docs/cli/commands#list-formats-command) | List all supported test frameworks           |
| [`version`](https://docs.qualflare.com/docs/cli/commands#version-command)           | Print the installed qf version               |

### Resource Queries

All resource commands require a saved identifier and output JSON, making them easy to filter with `jq`. Invoke as `qf <identifier> <command>`, e.g. `qf myapp suites list`. See [Query project data from the CLI](https://docs.qualflare.com/docs/cli/read-commands) for every flag and output field.

| Command                                                                                             | Description                       |
| --------------------------------------------------------------------------------------------------- | --------------------------------- |
| [`suites list` / `suite get`](https://docs.qualflare.com/docs/cli/read-commands#suites)             | List and inspect test suites      |
| [`cases list` / `case get`](https://docs.qualflare.com/docs/cli/read-commands#cases)                | List and inspect test cases       |
| [`plans list` / `plan get`](https://docs.qualflare.com/docs/cli/read-commands#plans)                | List and inspect test plans       |
| [`launches list` / `launch get`](https://docs.qualflare.com/docs/cli/read-commands#launches)        | List and inspect test launches    |
| [`defects list` / `defect get`](https://docs.qualflare.com/docs/cli/read-commands#defects)          | List and inspect defects          |
| [`clusters list` / `cluster get`](https://docs.qualflare.com/docs/cli/read-commands#clusters)       | List and inspect failure clusters |
| [`milestones list` / `milestone get`](https://docs.qualflare.com/docs/cli/read-commands#milestones) | List and inspect milestones       |

## Next Steps

* [Install the CLI](https://docs.qualflare.com/docs/cli/installation) for your platform
* [Configure authentication](https://docs.qualflare.com/docs/cli/authentication) and save your first identifier
* Learn about the [collect command](https://docs.qualflare.com/docs/cli/collect)
* Check the [supported formats](https://docs.qualflare.com/docs/cli/formats) and their `--format` values
* [Send CTRF reports](https://docs.qualflare.com/docs/cli/ctrf) from a runner that writes CTRF JSON
* [Upload Allure results](https://docs.qualflare.com/docs/cli/allure) from any Allure 2 adapter
* [Upload screenshots, videos and traces](https://docs.qualflare.com/docs/cli/artifacts)
* [Merge sharded runs](https://docs.qualflare.com/docs/cli/sharding) into one launch
* [Troubleshoot qf and CI uploads](https://docs.qualflare.com/docs/cli/troubleshooting)
* Look up every command in the [qf command reference](https://docs.qualflare.com/docs/cli/commands)
* Look up every setting in [Configuration and environment variables](https://docs.qualflare.com/docs/cli/configuration)
* Set up [CI/CD integration](https://docs.qualflare.com/docs/cli/ci-cd)
* Upload results from GitHub Actions with [`qualflare-action`](https://docs.qualflare.com/docs/cli/ci-cd/github-actions), which wraps `qf`

## Related Sections

* **[Core Concepts](https://docs.qualflare.com/docs/get-started/core-concepts)** — what suites, cases, launches, and defects are
* **[API & MCP](https://docs.qualflare.com/docs/api)** — the REST API and MCP server for the same resources these commands query
* **[Integrations](https://docs.qualflare.com/docs/integrations)** — connect CI/CD results to GitHub, Slack, and Jira
* **[FAQ](https://docs.qualflare.com/docs/faq)** — quick answers about the CLI tool
