Skip to content

Setup & Recording

There are two methods to set up and run the CaseRunner Recorder:

  • Method A — Using run.bat (Recommended)
  • Method B — Using a Python virtual environment (for restricted environments)

Step 1: Open a Terminal

Open PowerShell or Command Prompt and navigate to the folder containing your files:

cd C:\path\to\your\folder

Step 2: Install Chromium (one-time only)

.\run.bat playwright install chromium

run.bat playwright install chromium

This downloads the Chromium browser required for recording. You only need to do this once.

Step 3: Start Recording

.\run.bat record https://your-application-url.com

run.bat record https://your-application-url.com

Replace https://your-application-url.com with the actual URL of the application you want to record.

View All Options

To see additional recording options and parameters:

.\run.bat record -h

run.bat record -h

Method B — Using Python Virtual Environment

Use this method if you encounter IT restrictions or issues running the batch file.

Step 1: Open a Terminal

Open PowerShell or Command Prompt and navigate to the folder containing your files:

cd C:\path\to\your\folder

Step 2: Create a Virtual Environment (one-time only)

py -m venv .venv

Step 3: Install the Recorder Package (one-time only)

.\.venv\Scripts\python -m pip install caserunner_recorder-0.3.1-py3-none-any.whl

Note

Replace the filename with the exact name of the .whl file provided to you.

Step 4: Install Chromium (one-time only)

.\.venv\Scripts\python -m playwright install chromium

Step 5: Start Recording

.\.venv\Scripts\python -m caserunner record https://your-application-url.com

During Recording

  • A Chromium browser window will open automatically.
  • Navigate through your application and perform the interactions you want to record.
  • The recorder captures all clicks, inputs, and navigation.
  • To stop recording: Simply close the browser window.

Output

Once recording is complete, the tool generates an output.zip file in the same folder where you ran the command. This file contains all the captured metadata from your recording session.

Next Step

Upload the recording to CaseRunner.