For more background information on the project, please read this overview.
Flow works with:
There are binary distributions for each of these platforms and you can also build it from source on any of them as well.
Flow is written in OCaml (OCaml 4.10.2 is required).
- Mac: `brew install opam` - Debian: `sudo apt-get install opam` - Other Linux: see [opam docs](https://opam.ocaml.org/doc/Install.html) - Windows: [cygwin](https://cygwin.com/) and a number of dependencies like `make`, `gcc` and `g++` are required.
One way to install everything is to install Chocolatey and then run
.\scripts\windows\install_opam.ps1. Otherwise, see the "Manual Installation" section of OCaml for Windows docs and install all of the packages listed in our
The remainder of these instructions should be run inside the Cygwin shell:
The following instructions expect
2.x.x. Should your package manager have installed a
1.x.xversion, please refer to the opam docs to install a newer version manually.
# on Mac and Linux: opam init
Install Flow's OCaml dependencies:
# from within this git checkout make deps
eval $(opam env) make
This produces the
opam install -y js_of_ocaml.3.9.0 make js
To run the tests, first compile flow using
make. Then run
bash ./runtests.sh bin/flow
There is a
make testtarget that compiles and runs tests.
To run a subset of the tests you can pass a second argument to the
bash runtests.sh bin/flow class | grep -v 'SKIP'