Command Line Interface

CukeTest provides a feature-rich Command Line Interface (CLI), allowing it to be operated not only via a graphical interface but also from the terminal to run and manage test projects. The command line functionality of CukeTest offers the following advantages:

• It can be easily integrated into Continuous Integration (CI) and Continuous Delivery (CD) pipelines, enabling fast feedback and quality assurance for automated testing.
• It provides flexible test parameter configurations, such as run profiles, test tags, and report formats.

Note: The command line instructions differ between the desktop and Windows Store versions of CukeTest. When switching between versions, make sure to use the corresponding commands.

Basic Usage

The table below lists the basic CukeTest CLI commands and their usage:

Below are some common CLI operation examples:

1. Open a project

• To open the current directory as a project in CukeTest, use:

   cuketest .
  

  This opens the current directory as the project root in CukeTest.

2. Open a specific file

• To open a specific Feature file in the current directory, use:

   cuketest feature/feature1.feature
  

  For example, this opens the feature1.feature file under the feature subdirectory in CukeTest.

3. Run a project

• To run the project in the project directory, use:

   cuketest run
  

  This executes the automated tests in the project with default configuration.

Command Line Options

The CukeTest CLI provides various options, allowing users to customize test execution and environment settings according to different scenarios. The main CukeTest command line options are described below:

cuketest

This is the basic command, used to launch CukeTest or obtain help information.

Usage Examples:

• Install extension: cuketest --install-extension <extension-path>

• Uninstall extension: cuketest --uninstall-extension <extension-name>

• List extensions: cuketest --list-extensions

cuketest run

The cuketest run command is the core of the CukeTest CLI, offering rich options to customize test execution configurations.

Usage Examples:

• Run project with default configuration: cuketest run

• Run project, generate HTML report and record video: cuketest run --format html --video

• Run tests filtered by tags: cuketest run -t "@backend or @ui"

• Run a specific script and pass arguments: cuketest run --file ./scripts/check_status.js --env=prod --user-role=admin

  In this example, --env=prod and --user-role=admin will be passed directly to the check_status.js script as arguments.

• Use a specific profile: cuketest run --profile "regression_test"

  Here regression_test is a pre-defined configuration in the config/cucumber.yml file. For more details on how to configure and use different run profiles, please refer to the Project Run Profiles document.

• Disable colored output: cuketest run --no-color

  In some terminals (e.g., Jenkins or Windows Task Scheduler) where colored display is not supported, the output may appear garbled. In these cases, using the --no-color option ensures monochrome output, maintaining readability.

cuketest worker

The cuketest worker command is used to start CukeTest's remote worker to receive automation requests locally or remotely. It supports the following options:

cuketest batch

The cuketest batch command allows users to batch run multiple CukeTest projects via .cukerun files:

cuketest launch

The cuketest launch command is used to launch the test application, loading CukeTest's automation plugins (such as Qt, GuiText) at startup.:

cuketest mcp

cuketest mcp is used to start CukeTest's built-in MCP server. Currently, Playwright MCP is built-in and can be started directly to connect with MCP-supported client tools.

cuketest mcp --port 8801

After starting, it will listen on an address like http://localhost:8801, and the MCP endpoint is:

http://localhost:8801/mcp

You can add this to the client configuration:

{
  "mcpServers": {
    "playwright": {
      "url": "http://localhost:8801/mcp"
    }
  }
}

If you need compatibility with legacy SSE transport, you can use the /sse endpoint.

CLI for Windows Store Version

For the Windows Store version of CukeTest, running tests from the command line needs to follow specific Windows Store guidelines. This means that command line parameters might differ from other desktop application versions. Here are the steps to run tests from the command line:

1. In the CukeTest application, go to the Run menu and select the Run Profiles option.

2. In the profile editing dialog, set your test configurations according to your requirements. Once finished, at the bottom of the dialog, you will see the generated command line parameters, which you can copy.

3. Click the Open Console Window button, which will open a command line interface.

4. In the opened console window, paste the text you just copied.

   

This way, you can use the command line to run and manage your CukeTest projects in the Windows Store version environment.

CLI for macOS

CukeTest also provides full command line support on Mac, with command formats largely identical to Windows and Linux versions. You can generate the required command line in the "Run Profiles" dialog and use it freely in the terminal.

When executing the cuketest command in macOS Terminal, the cuketest command should be changed to:

/Applications/CukeTest.app/Contents/MacOS/cuke

Configuring System Permissions

To ensure that CukeTest can smoothly execute automated tests in the Mac command line environment, especially tests involving screen operations, you need to grant "Screen Recording" and "Accessibility" permissions to the terminal application in Mac's "System Preferences". This step is very important to ensure the smooth execution of tests. For detailed setup steps, please refer to our Mac Platform Installation Guide, which contains detailed instructions and illustrations to help you complete the relevant configurations.

Through the above settings, no matter which operating system version of CukeTest you use, you can efficiently manage and execute automated tests via the command line interface.