CLI Tool
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 23 frameworks, 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
# Save your API token under a local identifier
qf login myapp qf_your_token_here
# Upload test results
qf myapp collect results.xml
# List test suites
qf myapp suites listCommands
Authentication
| Command | Description |
|---|---|
login <identifier> <token> | Save an API token under a local project identifier |
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 | Display CLI version information |
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.
| 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
- Explore other commands
- Set up CI/CD integration