Installation

Even though, Ferret comes as a CLI executable, it also can be used as a library.

CLI

From binary

You can either download latest binaries from here

or use the following shell script:

$ curl https://raw.githubusercontent.com/MontFerret/ferret/master/install.sh | sudo sh

From the source

$ go get github.com/MontFerret/ferret

Library

$ go get github.com/MontFerret/ferret/pkg/compiler

Environment

In order to use all Ferret features, you will need to have Chrome/Chromium either installed locally or running in Docker. For ease of use we recommend to run Chrome/Chromium inside a Docker container.

You can use any Chromium-based headless image, but we’ve put together an image that’s ready to go:

$ docker pull montferret/chromium
$ docker run -d -p 9222:9222 montferret/chromium

If you’d rather see what’s happening during query execution, just start launch Chrome from your host with the remote debugging port set:

$ chrome.exe --remote-debugging-port=9222