Get Started

Suites Commands ​

Test suites in Qualflare are collections of related test cases, used to organize your testing work by feature, module, or team. The suites commands let you list and inspect suites from the command line.

qf suites list ​

List test suites in your project. Results are output as pretty-printed JSON to stdout.

Syntax ​

bash
qf suites list [flags]

Flags ​

FlagTypeDefaultDescription
--querystring""Filter suites by name or description
--pageint0Page number for paginated results
--sort-bystring""Field to sort results by (e.g., name, createdAt)
--sort-descboolfalseSort in descending order
--api-keystring""API key for authentication. Overrides QF_API_KEY environment variable.

Examples ​

bash
# List all suites
qf suites list

# Search for suites by name
qf suites list --query "authentication"

# Sort by name, alphabetically
qf suites list --sort-by name

# Sort by creation date, newest first
qf suites list --sort-by createdAt --sort-desc

# Paginate through large result sets
qf suites list --page 2

Example Output ​

json
{
  "suites": [
    {
      "seq": 42,
      "title": "Authentication Tests",
      "description": "Tests for login, logout, and session management",
      "caseCount": 18,
      "createdAt": "2026-03-15T10:30:00Z"
    },
    {
      "seq": 43,
      "title": "Checkout Flow",
      "description": "End-to-end checkout and payment tests",
      "caseCount": 11,
      "createdAt": "2026-03-16T08:00:00Z"
    }
  ]
}

qf suite get ​

Retrieve full details for a single test suite by its sequence number.

Syntax ​

bash
qf suite get <seq>

Arguments ​

ArgumentDescription
seqThe suite's sequence number (visible in the Qualflare UI and suites list output)

Flags ​

FlagTypeDefaultDescription
--api-keystring""API key for authentication. Overrides QF_API_KEY environment variable.

Examples ​

bash
# Get details for suite #42
qf suite get 42

Example Output ​

json
{
  "seq": 42,
  "title": "Authentication Tests",
  "description": "Tests for login, logout, and session management",
  "caseCount": 18,
  "createdAt": "2026-03-15T10:30:00Z",
  "updatedAt": "2026-03-20T14:15:00Z"
}

Working with JSON Output ​

All suites commands output pretty-printed JSON, making them easy to pipe into jq for filtering and transformation.

bash
# Extract just suite titles and sequence numbers
qf suites list | jq '.suites[] | {seq, title}'

# Count total suites returned
qf suites list | jq '.suites | length'

# Filter suites with more than 10 cases
qf suites list | jq '[.suites[] | select(.caseCount > 10)]'

# Extract all suite IDs as a plain list
qf suites list | jq '[.suites[].seq]'

# Find suites matching a pattern in the title
qf suites list | jq '[.suites[] | select(.title | test("auth"; "i"))]'

# Get the name of suite #42
qf suite get 42 | jq '.title'

See Also ​