OpenQAOpenQA
Get Started

Installation

Install OpenQA using the one-liner script, manual installation, or Docker.

One-Line Installation (Recommended)

The fastest way to get started:

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

This script will:

  • Check for required dependencies (Node.js, npm)
  • Clone the OpenQA repository
  • Install dependencies and build
  • Set up the CLI globally
  • Create a default configuration file

Manual Installation

If you prefer manual installation:

bash
1# Clone the repository
2git clone https://github.com/Orka-Community/OpenQA.git
3cd openqa
4 
5# Install dependencies
6npm install
7 
8# Build the project
9npm run build
10 
11# Create your configuration
12cp .env.example .env
13 
14# Link the CLI globally (optional)
15npm link

Configure your LLM

Edit the .env file and add your LLM API key:

bash
1# Choose your LLM provider
2LLM_PROVIDER=openai  # or anthropic, ollama
3 
4# Add your API key
5OPENAI_API_KEY=sk-your-api-key-here
6# or
7ANTHROPIC_API_KEY=sk-ant-your-key-here

Docker Installation

Run OpenQA in a container:

bash
1# Using docker-compose (recommended)
2docker-compose up -d
3 
4# Or using docker directly
5docker run -d \
6  -p 3000:3000 \
7  -e OPENAI_API_KEY=sk-your-key \
8  -e SAAS_URL=https://your-app.com \
9  -v openqa-data:/app/data \
10  openqa/openqa:latest

Requirements

RequirementVersionNotes
Node.js≥ 18.0.0LTS recommended
npm≥ 9.0.0Comes with Node.js
LLM API Key-OpenAI, Anthropic, or Ollama

Verify Installation

After installation, verify everything is working:

bash
1# Check OpenQA version
2openqa --version
3 
4# Check status
5openqa status

💡 Tip: If the openqa command is not found, you may need to restart your terminal or add the npm global bin to your PATH.

Next Steps

Quickstart

Configure and run your first test

CLI Commands

Learn all available commands