Files
liqa/README.md
T
ars9 b0f2c72b5f docs: bring docs up to date and drop unused keys setting
- rewrite architecture, development, mcp and scenario docs to match the
  current code: single container, all mcp tools, runs, versioning,
  timeouts, settings, client routing and dev setup
- rewrite README as a general overview without liquio-specific wording
- remove the unused KEYS_DIR setting and ./keys compose mount
- remove the unused result parameter from step code execution
- complete .env.example with the file storage settings and fix the
  DB_PATH default
2026-09-30 21:18:41 +03:00

2.0 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

cp .env.example .env
docker compose up -d --build

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