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
curl -fsSL https://openqa.orkajs.com/install.sh | bashThis 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
# Clone the repository
git clone https://github.com/orka-js/openqa.git
cd openqa
# Install dependencies
npm install
# Build the project
npm run build
# Create your configuration
cp .env.example .env
# Link the CLI globally (optional)
npm linkConfigure your LLM
Edit the .env file and add your LLM API key:
bash
# Choose your LLM provider
LLM_PROVIDER=openai # or anthropic, ollama
# Add your API key
OPENAI_API_KEY=sk-your-api-key-here
# or
ANTHROPIC_API_KEY=sk-ant-your-key-hereDocker Installation
Run OpenQA in a container:
bash
# Using docker-compose (recommended)
docker-compose up -d
# Or using docker directly
docker run -d \
-p 3000:3000 \
-e OPENAI_API_KEY=sk-your-key \
-e SAAS_URL=https://your-app.com \
-v openqa-data:/app/data \
openqa/openqa:latestRequirements
| Requirement | Version | Notes |
|---|---|---|
| Node.js | ≥ 18.0.0 | LTS recommended |
| npm | ≥ 9.0.0 | Comes with Node.js |
| LLM API Key | - | OpenAI, Anthropic, or Ollama |
Verify Installation
After installation, verify everything is working:
bash
# Check OpenQA version
openqa --version
# Check status
openqa 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.