Documentation

Welcome to the kogiQA documentation. kogiQA is a UI test automation tool that interacts with web pages like a human would, without relying on JavaScript selectors.

Getting started

kogiQA is a desktop application for macOS, Windows and Linux. This design enables significantly more control over the browser you are testing compared to competitors that only offer a Chrome extension or run purely inside the browser.

Install it via your package manager or use the standalone installer.

# macOS
brew install --cask kogiqa

# Windows
winget install kogiQA

# Debian / Ubuntu
wget -O kogi-qa-latest.deb https://updater.kogiqa.com/release/kogi-qa-latest.deb
sudo apt install ./kogi-qa-latest.deb
Download for macOS
Download for Windows
Download for Linux

How to get started

For the full step-by-step guide, see the How to get started page.

A minimal example to get going with the JavaScript SDK:

import {Browser} from "kogi";

const browser = await Browser.start("YOUR_ACCESS_TOKEN", "chrome", "My Test Session");

await browser.navigate("https://example.com");
await browser.click("Login");
await browser.type("Username", "john_doe");
await browser.type("Password", "secret123");
await browser.click("Submit");

await browser.hasText("Welcome");

await browser.close();

JavaScript SDK

The kogiQA JavaScript SDK provides a powerful and intuitive way to automate browser testing. With support for multiple browsers and advanced features like email testing, it makes end-to-end testing simple and reliable.

npm install kogi

You need an API access token from your account. You can find or generate this token in the Access settings in the kogiQA desktop client.

The SDK supports chrome, firefox, edge, safari and local browsers. The default is chrome.

For the full SDK guide, see the JavaScript SDK page.

MCP Server

The kogiQA MCP web browser gives your AI agent the power to control web pages locally on your device, helping you develop and debug complex web applications. It also assists with writing end-to-end tests.

# Auto install
npx kogiqa-mcp@latest

# Claude Code
claude mcp add kogiqa-browser npx kogiqa-mcp@latest

For the full MCP guide, see the MCP Server page.

API Reference

The complete API reference for all methods available in the kogiQA JavaScript SDK.

Highlights:

  • Browser.start, navigate, close
  • click, type, select, scroll, hover, resize
  • clickAtPosition, drawOnCanvas, selectText, uploadFile
  • dragStart, dragEnd, dragHover, dragFromTo
  • hasText, hasInput, hasButton
  • getPageText, textContent, evaluate, url, screenshot
  • autoLogin, clearSession, fuzzing
  • checkAccessibility, checkStructure, confetti, openPDF
  • createEmailAddress, fetchEmails, clearEmails
  • startProfiler, stopProfiler
  • runStep, exposePorts, setTimeout

For the full reference with parameters and examples, see the API Reference page.

Pricing

kogiQA offers simple pricing with a free tier for getting started and paid plans for teams running tests at scale.

For details, see the Pricing page.