This documentation is for an out-of-date version of Apache Flink. We recommend you use the latest stable version.

Running Flink on Windows

If you want to run Flink locally on a Windows machine you need to download and unpack the binary Flink distribution. After that you can WSL or Cygwin to run the Flink Jobmanager.

Starting with Cygwin and Unix Scripts

With Cygwin you need to start the Cygwin Terminal, navigate to your Flink directory and run the start-cluster.sh script:

$ cd flink
$ bin/start-cluster.sh
Starting cluster.

Back to top

If you are installing Flink from the git repository and you are using the Windows git shell, Cygwin can produce a failure similar to this one:

c:/flink/bin/start-cluster.sh: line 30: $'\r': command not found

This error occurs because git is automatically transforming UNIX line endings to Windows style line endings when running in Windows. The problem is that Cygwin can only deal with UNIX style line endings. The solution is to adjust the Cygwin settings to deal with the correct line endings by following these three steps:

  1. Start a Cygwin shell.

  2. Determine your home directory by entering

    cd; pwd
    
This will return a path under the Cygwin root path.
  1. Using NotePad, WordPad or a different text editor open the file .bash_profile in the home directory and append the following: (If the file does not exist you will have to create it)
export SHELLOPTS
set -o igncr

Save the file and open a new bash shell.

Back to top