OpenQAOpenQA
Get Started

Quickstart

Get started with OpenQA and autonomous testing in a few minutes

OpenQA is an autonomous QA testing agent that thinks, codes, and executes tests like a senior QA engineer. It analyzes your application, generates appropriate tests, and continuously improves.

This guide walks you through configuring your application and then running OpenQA.

Install OpenQA

bash
1curl -fsSL https://openqa.orkajs.com/install.sh | bash

This installs the OpenQA CLI and all dependencies. You can also install manually:

bash
1git clone https://github.com/orka-js/openqa.git
2cd openqa
3npm install && npm run build
4npm link

Configure Your Application

OpenQA needs just three pieces of information to get started:

  1. Name - Your application name
  2. Description - What your app does (be detailed!)
  3. URL - Where your app is running
bash
1curl -X POST http://localhost:3000/api/saas-config/quick \
2  -H "Content-Type: application/json" \
3  -d '{
4    "name": "My E-commerce App",
5    "description": "Online store with user accounts, product catalog, shopping cart, and Stripe checkout",
6    "url": "https://my-store.com"
7  }'

💡 Pro tip: The more detailed your description, the better tests OpenQA will generate. Include features, tech stack, and known problem areas.

Run OpenQA

Start the autonomous testing session:

bash
1curl -X POST http://localhost:3000/api/brain/run

OpenQA will now:

  • Analyze your application
  • Generate appropriate tests (unit, functional, E2E, security)
  • Create specialized agents as needed
  • Execute tests and report findings
  • Create GitHub issues for critical bugs

Next Steps

Add Directives

Custom instructions for the agent

Connect GitHub

Auto-test on merge/deploy

Test Generation

How the brain generates tests

API Reference

Full REST API documentation