Skip to main content

Katalon CLI Integration

This document shows you how to trigger test execution from existing test schedules on TestOps using Katalon CLI.

The Katalon Command-line Interface (CLI) Docker Image allows you to trigger test execution from existing test schedules on TestOps. You can use this image to integrate with your desired CI/CD pipeline and trigger execution upon code changes.

Katalon CLI is available on Docker Hub: Katalon CLI.

Prerequisites

  • You have Katalon CLI installed and set up via Docker Hub.
  • Katalon API key – If you haven’t set one up yet, follow this guide to generate your API key.
  • Project ID - You can find your Katalon project ID in the URL (typically after /project/, e.g., ".../project/1234567/..."), or refer to this guide for more details.

Usage

With Docker installed and running, you can start triggering a schedule.

docker run katalonstudio/katalon-cli schedule <parameters>

Parameters

  • --api-key: Your Katalon API key value

  • --username and --password: The username and password of your TestOps account.

  • --project-id: The ID of the project that contains your test schedule.

  • --operator=<NAME_CONTAINS | NAME_STARTS_WITH | NAME_ENDS_WITH>: The operator to filter the schedule, by id or by naming pattern.

  • --values: The value that corresponds with the operator in use.

Environment variables: You can use environment variables instead of parameters.

  • API_KEY
  • USERNAME
  • PASSWORD
  • PROJECT_ID
  • OPERATOR
  • VALUES

Trigger command for TestOps schedules

  1. Trigger an execution with username / password and name pattern matching (--project-id is required). This command triggers all schedules whose names contain the word "multiple".
docker run katalonstudio/katalon-cli schedule trigger 
--username=sample.email@katalon.com
--password=password
--project-id=123456
--operator=NAME_CONTAINS
--values="multiple"

Result

Once executed successfully, the command will upload your report to Katalon TestOps. Navigate to Reports to view all uploaded test reports.

Katalon CLI uploaded files successfully
Was this page helpful?