Documentation / Installation

Installation

Install

You can run Browsertime in two ways: with our Docker image or as a Node.js install. Docker is the easiest path because the image already contains Chrome, Firefox, Xvfb and the dependencies needed for video recording and Visual Metrics.

Docker #

We publish Docker images with Browsertime, Chrome, Firefox and Xvfb. Xvfb is started for you when the container boots, so you only need to install Docker and run the image.

Mac & Linux #

docker run --rm -v "$(pwd)":/browsertime sitespeedio/browsertime:27.2.0 --video --visualMetrics https://www.sitespeed.io/

Windows #

C:\Users\Vicky> docker pull sitespeedio/browsertime
C:\Users\Vicky> docker run --rm -v "$(pwd)":/browsertime sitespeedio/browsertime:27.2.0 https://www.sitespeed.io -b firefox

The result of the run is written to the current directory.

Standalone #

Mac & Linux #

Prerequisites:

• Node.js 20 or later (22.18+ if you want to use TypeScript navigation scripts). On Linux you can manage versions with nvm.
• npm (bundled with Node.js) or yarn.
• Chrome and/or Firefox installed locally.

npm #

npm install browsertime -g

yarn #

yarn global add browsertime

Windows #

We support Windows through Docker. Running Browsertime natively on Windows would need at least one core contributor to focus on Windows — if that is you, please get in touch.