Documentation / Installation

Installation

Install

Mac & Linux

Prerequisites: Install NodeJS 6.9.1 or newer (Linux) and make sure you have npm or yarn installed. You can also use Docker if you prefer.

npm

If you prefer npm, just run:

$ npm install sitespeed.io -g
$ sitespeed.io --help

yarn

Or with yarn:

$ yarn global add sitespeed.io
$ sitespeed.io --help

Docker

We have Docker images with sitespeed.io, Chrome, Firefox and Xvfb. They are super easy to use (Xvfb is started automatically when you start the container). Here’s how to use the container with both Firefox & Chrome (install Docker first).

$ docker pull sitespeedio/sitespeed.io
$ docker run --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io https://www.sitespeed.io -b firefox

Windows

We support Windows using Docker. To be able to support running on Windows with NodeJS we need more core contributors that can focus on Windows.

Docker

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

That will output the data from the run in the current directory. You can read more about running the containers here.