# e2e

> The open source AI testing framework. Customizable TypeScript testing framework for web, mobile apps and more.

e2e is a TypeScript end-to-end test runner by TesterArmy. Tests mix deterministic locators and assertions with agent steps (`agent.act`, `agent.assert`, `agent.extract`) that drive a real browser, iOS simulator, or Android emulator. Passing agent steps are cached and replayed without calling the model again. Bring your own model: an API key, Vercel AI Gateway, OpenRouter, or a ChatGPT, GitHub Copilot, or SuperGrok subscription.

## Set up e2e

For coding agents, install the e2e skill, then read `.agents/skills/e2e/SKILL.md` before writing or running a test:

```bash
npx skills add tester-army/e2e
```

To scaffold a project (config, example test, dependencies, the skill, and the `e2e mcp` server registration), run this in the app's directory:

```bash
npx e2e init
```

Requires Node.js 22.12 or newer. Run tests with `npx e2e run`. The [Quickstart](https://e2e.tester.army/docs/quickstart.md) covers pnpm, bun, and mobile targets.

- Source: https://github.com/tester-army/e2e

## Documentation

Every docs page is available as markdown by appending `.md`.

- [Docs index](https://e2e.tester.army/docs/llms.txt): list of all documentation pages
- [Quickstart](https://e2e.tester.army/docs/quickstart.md): run a first web or mobile test
- [Coding agents](https://e2e.tester.army/docs/coding-agents.md): the skill, the `e2e mcp` server, and reports for debugging
- [Writing tests](https://e2e.tester.army/docs/writing-tests.md): goals, checks, extraction, and the deterministic APIs
- [Models](https://e2e.tester.army/docs/models.md): configure a model with a subscription, an API key, or a local server
- [CLI reference](https://e2e.tester.army/docs/reference/cli.md): commands, flags, output formats, and exit codes
- [Config reference](https://e2e.tester.army/docs/reference/config.md): every `e2e.config.ts` key and its default
- [Continuous integration](https://e2e.tester.army/docs/ci.md): run tests on pull requests

## Links

- Landing page: https://tester.army/e2e
- Discord: https://tester.army/discord
- X: https://x.com/TesterArmy