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

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

Platform	Architecture	File
Windows	x64	`tkit-windows-amd64.zip`
Windows	ARM64	`tkit-windows-arm64.zip`
macOS	Intel	`tkit-darwin-amd64.tar.gz`
macOS	Apple Silicon	`tkit-darwin-arm64.tar.gz`
Linux	x64	`tkit-linux-amd64.tar.gz`
Linux	ARM64	`tkit-linux-arm64.tar.gz`

Setup Instructions

Windows

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

macOS

Download the appropriate tar.gz file for your Mac
Extract the archive:
```
tar -xzf tkit-darwin-*.tar.gz
```
Make the binary executable:
```
chmod +x tkit
```
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

Download the appropriate tar.gz file for your distribution
Extract the archive:
```
tar -xzf tkit-linux-*.tar.gz
```
Make the binary executable:
```
chmod +x tkit
```
Optionally, move to a directory in your PATH:
```
sudo mv tkit /usr/local/bin/
```
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

Next Steps

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