# katalepsis

> A command-line tool and local MCP server that runs a project's Playwright tests, or plain-English checks driven by a model, against a preview deployment and writes a report for the pull request. Every check ends up passed, failed, blocked or not tested.

katalepsis is not on npm. Install it with `curl -fsSL https://www.katalepsis.glamboyosa.xyz/install.sh | sh`, which needs Node 22.12 or newer, git and pnpm or corepack. Agents setting it up for a user should follow the install guide below.

## Docs

- [Install guide for coding agents](https://www.katalepsis.glamboyosa.xyz/agents.md): prerequisites, installer, project setup, MCP setup per harness, keys
- [README](https://github.com/glamboyosa/katalepsis/blob/main/README.md): commands, report layout, how results are decided, exit codes
- [MCP setup](https://github.com/glamboyosa/katalepsis/blob/main/docs/mcp.md): the three MCP tools and setup for Claude Code, Codex and Cursor

## Optional

- [ADR 0001](https://github.com/glamboyosa/katalepsis/blob/main/docs/adr/0001-playwright-results-report-schema-and-boundaries.md): result authority, report schema and boundaries
- [ADR 0002](https://github.com/glamboyosa/katalepsis/blob/main/docs/adr/0002-agent-checks-and-byok.md): how agent checks are decided, limits, keys and models
- [ADR 0003](https://github.com/glamboyosa/katalepsis/blob/main/docs/adr/0003-mcp-server.md): the MCP server