Files
liqa/README.md
T
Andrii Arsenin 6bc1b6fb19 chore: make .env optional and comment out all example settings
- load .env in compose only when it exists; every setting has a default
- comment out every setting in .env.example, with ## for descriptions
  and # VAR=default for settings to uncomment
- update README, development docs and CLAUDE.md accordingly
2026-09-30 21:23:18 +03:00

2.1 KiB

liqa

A browser automation and QA service for web applications. It stores multi-step browser scenarios, runs them with Playwright in headless Chromium, and keeps their results, logs and artifacts. Scenarios are managed from a web UI, a REST API, or an MCP (Model Context Protocol) server that lets AI agents define, run and debug them.


Quick start

docker compose up -d --build

No configuration is needed: every setting has a default. To override one, copy .env.example to .env and uncomment it.

Everything is served from one container at http://localhost:13000: the UI at /, the REST API at /api/v1, MCP at /mcp, Swagger at /docs. Data is kept in ./data/.


Overview

Concept Description
Scenario An ordered list of steps (async Playwright JS) that run in sequence in one browser. Versioned: every content change creates a new version
Run One execution of a scenario version in an environment, with per-step status and output, logs, and run files (downloads, failure screenshots, Playwright traces)
Snippet Reusable, versioned code called from steps with context.runSnippet("alias") (or "alias@N" for a specific version)
Environment A named set of key/value settings for a deployment target (URLs etc.), read with context.getEnv(key)
Credential Secret data (e.g. a key file and password), assigned to scenarios under an alias and read with context.getCredential(alias)
Session Saved browser state (cookies + localStorage), e.g. kept from a run with "save session"

Scenarios, snippets, environments and credentials can be exported as YAML and imported back (one file may hold several of them).


Documentation