# Benchmark

> Run and author benchmark tests in xterm.js. Use when editing benchmark files, working in `*.benchmark.ts`, or when asked how to run the full benchmark suite, a single benchmark file, or a single benchmark case.

- Skill: `xtermjs/benchmark` (Agent Skill)
- Install (CLI): `npx skillmds@latest add xtermjs/benchmark`
- Raw SKILL.md: https://api.skillmd.com/api/skills/xtermjs/benchmark/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: xtermjs (https://skillmd.com/u/xtermjs)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/xtermjs/benchmark

---


# Benchmark Run Instructions

## Running Benchmarks

- Full suite: `npm run benchmark`
- Single benchmark file:
  - Tree: `npm run benchmark -- -t out-test/benchmark/Event.benchmark.js`
  - Run file: `npm run benchmark -- -s "out-test/benchmark/Event.benchmark.js" out-test/benchmark/Event.benchmark.js`
- Single context/case:
  - Use `-t` to get the path, then:
  - `npm run benchmark -- -s "<path>" out-test/benchmark/Event.benchmark.js`

## Benchmark Case Selection

When writing benchmark instructions:

- Use `RuntimeCase` to measure pure runtime in ms.
- Use `ThroughputRuntimeCase` when measuring throughput in MB/s.

## Notes

- Benchmarks run from built JS in `out-test/benchmark/*.benchmark.js`.
- Keep `NODE_PATH=./out` (handled by the npm script).