# ubq

> ubq is a test tool for TypeScript and JavaScript, made for coding agents and the people who work with them. The package is `ubqtest`. The command is `ubq`. It runs on Node 24 or later, Bun, and Deno. This index is for version 0.0.7.

Each page of this site is also a markdown file: `<page>.md`. In a project that has the package, `npx ubq guide` prints the guide for the installed version. Use that text if it is available, because it is correct for that version.

ubq has no `it`, no `expect`, no hooks, and no `.only`. Read the guide before you write a test.

## Documentation

- [Overview](index.md): what ubq is, the commands, and the limits.
- [Guide](guide.md): The API, the rules, and the commands.
- [API reference](api.md): Each export of the package, with its type.
- [Convert a project](convert.md): How to move a project from tap, node:test, vitest, jest, or mocha.
- [Configuration](config.md): Which files ubq runs, and the `ubq` key of `package.json`.
- [Agent skill](skill.md): The `use-ubq` skill that `ubq skill` writes for your agent.
- [License](license.md): Blue Oak Model License 1.0.0.
- [All of the above in one file](llms-full.txt)

## Optional

- [Goals](docs/goals.md): The goals of the project, from its author.
- [What agents need](docs/agent-needs.md): What an agent needs from a test tool. Written by an agent, before the design.
- [Decisions](docs/decisions.md): Each design decision, with its reason.
- [Measurements](docs/measurements.md): The measured costs that the design depends on.
- [Architecture](docs/architecture.md): The parts, the process model, events, coverage, and the store.
- [API design](docs/api-design.md): The test file API, and what is absent on purpose.
- [Events](docs/events.md): The events that a test process sends to the runner.
- [Status](docs/status.md): What is built, and the known limits.
- [Open questions](docs/questions.md): Points that wait for a decision.
- [Coverage on Bun](docs/bun-coverage.md): What ubq needs from Bun for coverage of each test.
- [Server](docs/server.md): The optional background server.