Qualflare CLI Tool
Upload test results from 27 frameworks and 4 generic formats with the Qualflare CLI, then query suites, cases, plans, launches and defects.
Last updated
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
# 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 listCommands
Authentication
| Command | Description |
|---|---|
login <identifier> [token] | 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> | Remove saved credentials for an identifier |
projects | List all saved project identifiers |
Data Collection
| Command | Description |
|---|---|
collect | Parse and upload test results to Qualflare |
validate | Validate test result files without uploading |
list-formats | List all supported test frameworks |
version | 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 for every flag and output field.
| Command | Description |
|---|---|
suites list / suite get | List and inspect test suites |
cases list / case get | List and inspect test cases |
plans list / plan get | List and inspect test plans |
launches list / launch get | List and inspect test launches |
defects list / defect get | List and inspect defects |
clusters list / cluster get | List and inspect failure clusters |
milestones list / milestone get | List and inspect milestones |
Next Steps
- Install the CLI for your platform
- Configure authentication and save your first identifier
- Learn about the collect command
- Check the supported formats and their
--formatvalues - Send CTRF reports from a runner that writes CTRF JSON
- Upload Allure results from any Allure 2 adapter
- Upload screenshots, videos and traces
- Merge sharded runs into one launch
- Troubleshoot qf and CI uploads
- Look up every command in the qf command reference
- Look up every setting in Configuration and environment variables
- Set up CI/CD integration
- Upload results from GitHub Actions with
qualflare-action, which wrapsqf
Related Sections
- Core Concepts — what suites, cases, launches, and defects are
- API & MCP — the REST API and MCP server for the same resources these commands query
- Integrations — connect CI/CD results to GitHub, Slack, and Jira
- FAQ — quick answers about the CLI tool
TestNG reporter
Add com.qualflare:qualflare-testng as a test dependency, run mvn test or gradle test, and upload the qualflare-results folder with the Qualflare CLI.
Install Qualflare CLI
Install the Qualflare CLI (qf) on macOS, Linux or Windows with Homebrew, npm, Docker or a release archive, and check the download against its signed checksums.