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

Read the project overview from the CLI

Print a Qualflare project's Overview dashboard numbers with qf overview as JSON, over the last 7 or 28 days, with each number's change and daily values.

Last updated

To read a project's Overview dashboard numbers in Qualflare from a terminal or a script, run qf <identifier> overview; you need the Viewer role or higher on the project. It prints six numbers as JSON: success rate, flake rate, launch p90, automation, defects opened and launches.

qf ≥ 0.6.0 (requires qf 0.6.0 or later)

Before you begin

  • qf installed (Install qf) and an identifier saved for the project with qf login.
  • The Viewer role or higher on the project, as for every read command.

qf overview covers the last 7 days by default, or the last 28 with --days 28:

qf myapp overview
qf myapp overview --days 28 | jq '.kpis[] | {key, latest, previous, trend}'
FlagTypeDefaultDescription
--daysint7Window in days: 7 or 28

Output fields

The qf overview output has four parts:

  • window (from, to and days) and buckets, one UTC day each, oldest first.
  • kpis, one entry per number, each with key, label, unit, latest, previous, percentChange, trend, target and values. The keys are successRate, flakeRate, launchP90, automationRate, defectsOpened and launches. unit is percent (0 to 100), seconds or count.
  • warnings, notes about the data.
  • dataThrough, how current the numbers are. They lag a finished run by a few minutes.

Each number in kpis reads as follows:

  • latest is the most recent day with a reading, not a total over the window. For defectsOpened and launches, it is today's UTC count so far.
  • previous is the daily average over the same number of days before the window, and percentChange compares the two.
  • trend is up, down, none (a change of 0.1% or less) or neutral (nothing earlier to compare with). It gives the direction only, so a rising flake rate is up too.
  • target is the project's target, null when none is set and always null for the two counts.
  • values holds one reading per bucket, null on a day without one.

Troubleshoot

--days must be 7 or 28: the flag takes only those two values, and qf refuses any other before it sends a request.

dataThrough is null, or the numbers stay at zero after a run: the numbers lag a finished run by a few minutes. null means the time of the latest update couldn't be read. Run the command again a few minutes later.

Exit code 3, 4 or 5: the same causes as for any read command; see Exit codes.