Skip to content
The docs are now organized by product area. Old links still work. Report a broken link

Configuration and environment variables

Reference for Qualflare CLI settings: every QF_* environment variable and its default, the global flags, CI branch and commit detection, and which setting wins.

Last updated

This page lists every setting of the Qualflare CLI (qf): the QF_* environment variables and their defaults, such as development for QF_ENVIRONMENT, the global flags, and CI auto-detection. A flag beats an environment variable, which beats the report file, auto-detection and the built-in defaults.

Configuration priority

Highest to lowest:

  1. Command-line flags (e.g., --environment, --branch)
  2. Environment variables (e.g., QF_ENVIRONMENT, QF_BRANCH)
  3. The report file: the environment and platform a native reporter wrote into its report
  4. Auto-detection: CI platform variables, then the local git checkout (branch and commit only)
  5. Built-in defaults

Authentication is separate from this priority chain — credentials are stored per-identifier in a local config file by qf login.

Authentication

qf keeps credentials apart from these settings: qf login <identifier> signs in (or saves a project access token) under a local identifier, and QF_TOKEN is read only by qf login. Token sources, identifier rules, the credentials file and CI setup are in Authenticate with qf login.

Global flags

These flags are available on every qf command:

FlagShortTypeDefaultEnv VarDescription
--verbose-vboolfalseQF_VERBOSEEnable verbose debug output.
--quiet-qboolfalseQF_QUIETSuppress all non-error output.
--debugboolfalseQF_DEBUGLog full HTTP request/response detail to stderr (token redacted).
--no-capture-outputboolfalseQF_NO_CAPTURE_OUTPUTStrip captured stdout/stderr and custom test properties before uploading.

Environment variables

All environment variables can be set in your shell profile, .env file, or CI/CD secrets.

Test run metadata

VariableDefaultDescription
QF_ENVIRONMENTdevelopmentIdentifier of the environment the tests ran against. It must already exist in the project (Settings → Environments). New projects have development, staging, production and qa.
QF_LANGUAGEen-USLanguage of the launch, as a language tag Qualflare supports (e.g., en-US, de-DE). An unsupported tag fails the upload.
QF_PLATFORMapiPlatform the tests ran on. One of android, ios, desktop, web, api.
QF_BRANCHAuto-detectedGit branch name. Auto-detected from CI environment if not set.
QF_COMMITAuto-detectedGit commit SHA. Auto-detected from CI environment if not set.
QF_MILESTONE(none)Milestone sequence number to link the launch to. Values below 1 are ignored, and the milestone must exist in the project.
QF_UPLOAD_ARTIFACTS(screenshots only)Artifact kinds collect uploads in addition to screenshots: video, trace. image (screenshots) is accepted and already on. Set none to upload no artifacts. Same as --upload-artifacts.

Retry & timeout

VariableDefaultDescription
QF_RETRY_MAX3Maximum number of retry attempts (capped at 10).
QF_RETRY_DELAY1sBase delay between retries (exponential backoff).
QF_RETRY_MAX_DELAY30sMaximum delay between retries.
QF_TIMEOUT120sTimeout for each HTTP request attempt, and the overall deadline for read commands such as suites list. Go duration, e.g. 500ms, 60s, 2m. The overall deadline of collect is its --timeout flag (default 30s).

Output

VariableDefaultDescription
QF_VERBOSEfalseSet to true or 1 to enable verbose output.
QF_QUIETfalseSet to true or 1 to suppress non-error output.

QF_TOKEN is read only by qf login: see Authenticate with qf login.

Plan limits

VariableDefaultDescription
QF_WARN_ON_PLAN_LIMITfalseSet to true or 1 so that collect warns and exits 0 instead of 4 when a plan limit refuses the upload. The results are not uploaded. Same as --warn-on-plan-limit. qf ≥ 0.7.0 (requires qf 0.7.0 or later)

CI auto-detection

In CI environments, the CLI automatically detects git metadata from well-known environment variables. Manual flags and QF_* variables always override auto-detection.

Branch detection

The CLI checks these variables in order, using the first non-empty value:

QF_BRANCH → GIT_BRANCH → GITHUB_REF_NAME → CI_COMMIT_REF_NAME → BITBUCKET_BRANCH

Commit detection

The CLI checks these variables in order, using the first non-empty value:

QF_COMMIT → GIT_COMMIT → GITHUB_SHA → CI_COMMIT_SHA → BITBUCKET_COMMIT

If none of these is set, collect reads the branch and commit from the local git checkout. A detached HEAD, which many CI checkouts use, gives no branch, so set QF_BRANCH or pass --branch there.

Related