Installation

TestFlowKit is a standalone executable that requires no complex installation process. Choose the installation method that works best for you.

Prerequisites

Before installing TestFlowKit, ensure you have:

• ℹ️ A modern web browser (Chrome or Edge) for frontend testing
• ℹ️ A computer running Windows, macOS, or Linux
• ℹ️ Optional: Go 1.19+ if you plan to use the Playwright browser driver

Installation Methods

Method 1: npm (Recommended)

The easiest way to install TestFlowKit is via npm. This method automatically downloads the correct binary for your platform.

# Global installation
npm install -g @testflowkit/cli

# Or use npx directly without installing
npx @testflowkit/cli --version

After installation, the tkit command will be available globally:

tkit --version

ℹ️ Requirements: Node.js 16.0.0 or higher is required for npm installation.

Method 2: Direct Download

Download the latest version of TestFlowKit for your platform from the GitHub Releases page.

Available Platforms

Setup Instructions

Windows

1. Download the appropriate ZIP file for your architecture
2. Extract the ZIP file to a folder of your choice
3. Open Command Prompt or PowerShell
4. Navigate to the folder containing tkit.exe
5. Run .\tkit.exe --version to verify the installation

macOS

1. Download the appropriate tar.gz file for your Mac
2. Extract the archive:

   tar -xzf tkit-darwin-*.tar.gz
   

3. Make the binary executable:

   chmod +x tkit
   

4. Verify the installation:

   ./tkit --version
   

⚠️ macOS Security: On first run, macOS may block the application. Go to System Preferences > Security & Privacy and click "Allow Anyway" to permit TestFlowKit to run.

Linux

1. Download the appropriate tar.gz file for your distribution
2. Extract the archive:

   tar -xzf tkit-linux-*.tar.gz
   

3. Make the binary executable:

   chmod +x tkit
   

4. Optionally, move to a directory in your PATH:

   sudo mv tkit /usr/local/bin/
   

5. Verify the installation:

   tkit --version
   

Verify Installation

After installation, verify that TestFlowKit is working correctly:

tkit --version

You should see output similar to:

TestFlowKit version 2.0.0

Installing Browser Drivers

TestFlowKit provides an install command to automatically set up browser drivers based on your configuration.

The driver installation is selected from the frontend.driver value in the config file passed to --config.

• If frontend.driver: "rod", no external browser driver is installed.
• If frontend.driver: "playwright", Playwright dependencies are installed.

Install Command

tkit install --config=config.yml

Example:

frontend:
   driver: "playwright"

With this config, tkit install --config=config.yml installs Playwright browser dependencies.

Driver-Specific Behavior

Rod Driver (default)

• ✅ No installation needed - bundled with TestFlowKit
• Auto-downloads Chrome when needed

Playwright Driver

• Requires Go 1.19+ and internet connection
• Automatically installs Chromium and system dependencies
• Downloads browser binaries (~300MB)

Using the Playwright Driver

1. Set the driver in your config.yml:

frontend:
  driver: "playwright"

2. Run the install command:

tkit install --config=config.yml

ℹ️ Note: You only need to run tkit install once per driver. Re-run it only when switching drivers or after updates.

Next Steps

Now that TestFlowKit is installed, continue to the Quick Start guide to write your first test.