For a background on the project, please read this overview.
- Using Flow
- Building Flow from source
- Join the Flow community
Flow works with:
- macOS (x86_64)
- Linux (x86_64 and arm64)
- Windows (x86_64, Windows 10 recommended)
There are binary distributions for each of these platforms and you can also build it from source on any of them as well.
Building Flow from source
Flow is written in OCaml (OCaml 4.09.1 is required).
brew install opam
sudo apt-get install opam
- Other Linux: see opam docs
- Windows: see OCaml for Windows docs
- Validate the
The following instructions expect
Should your package manager have installed a
please refer to the opam docs to install a newer version manually.
- Install OCaml and Flow's dependencies:
# from within this git checkout opam switch create . --deps-only -y
- Build the
eval $(opam env) make
This produces the
opam install -y js_of_ocaml.3.7.1 make js
Running the tests
To run the tests, first compile flow using
make. Then run
bash ./runtests.sh bin/flow
There is a
make test target 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'
Join the Flow community
- Website: https://flow.org
- Discord: https://discord.gg/8ezwRUK
- irc: #flowtype on Freenode
- Twitter: follow @flowtype and #flowtype to keep up with the latest Flow news.
- Stack Overflow: Ask a question with the flowtype tag