This guide describes how to set up your development environment to run Flutter apps on iOS or Android.

System requirements

To install and run Flutter, your development environment must meet these minimum requirements:

  • Operating Systems: Mac or Linux (64-bit). Windows support is in progress.
  • Tools: Flutter depends on these command-line tools being available on your environment.
    • bash, mkdir, rm, git, curl, unzip

Get the Flutter SDK

To get Flutter, use git to clone the repository and then add the flutter tool to your path:

$ git clone https://github.com/flutter/flutter.git
$ export PATH=`pwd`/flutter/bin:$PATH

Run the following command to see if there are any dependencies you need to install to complete the setup:

$ flutter doctor

The first time you run the flutter command, it will download its dependencies and compile itself. Subsequent runs should be much faster.

Once you have installed any missing dependencies, run the flutter doctor command again to verify that you’ve set everything up correctly.

Google Analytics

The Flutter tool uses Google Analytics to anonymously report feature usage statistics and basic crash reports. This data is used to help improve Flutter tools over time. In order to disable reporting, type flutter config --no-analytics, and to display the current state of analytics reporting, type flutter config.

Analytics is not sent on the very first run or for any runs involving flutter config. This lets users choose to opt-out of analytics without any data being sent. See Google’s privacy policy: www.google.com/intl/en/policies/privacy.

iOS setup

This step is optional, and can be performed at any time before using Flutter to develop apps for iOS.

To develop Flutter apps for iOS, you need a Mac with Xcode 7.2 or newer:

  1. Install Xcode 7.2 or newer (via web download or the Mac App Store).
  2. Configure the Xcode command-line tools to use the newly-installed version of Xcode by running sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer from the command line.

This is the correct path for most cases, when you want to use the latest version of Xcode. If you need to use a different version, specify that path instead.

  1. Make sure the Xcode license agreement is signed by either opening Xcode once and confirming or running sudo xcodebuild -license from the command line.

With Xcode, you’ll be able to run Flutter apps on an iOS device or on the simulator.

Set up the iOS simulator

To prepare to run and test your Flutter app on the iOS simulator, follow these steps:

  1. On your Mac, find the Simulator via Spotlight or by using the following command:

     $ open -a Simulator
    
  2. Make sure your simulator is using a 64-bit device (iPhone 5s or later) by checking the settings in the simulator’s Hardware > Device menu.
  3. Depending on your development machine’s screen size, simulated high-screen-density iOS devices may overflow your screen. Set the device scale under the Window > Scale menu in the simulator.

Deploy to iOS devices

To deploy your Flutter app to a physical iOS device, you’ll need some additional tools:

  1. Install homebrew.
  2. Open the terminal and run this command to install the tools for deploying Flutter apps to iOS devices.

     $ brew install ideviceinstaller ios-deploy
     

You’ll also need to set up a provisioning profile for your developer account. To learn how to set up your profile, see Apple’s official documentation.

Android setup

This step is optional, and can be performed at any time before using Flutter to develop apps for Android.

To develop Flutter apps for Android, you can use either a Mac or a Linux (64-bit) machine:

  1. Install Android Studio.
  2. From Android Studio, install the latest Android SDK and Android SDK Platform-Tools, as described in Adding SDK Packages.

Set up your Android device

To prepare to run and test your Flutter app on Android, you’ll need an Android device running Android 4.1 (API level 16) or higher.

  1. Enable developer mode on your device by visiting Settings > About phone and tapping the Build number line seven times.
  2. In Settings > Developer options, enable USB debugging.
  3. Using a USB cable, plug your phone into your computer. If prompted on your device, authorize your computer to access your device.
  4. In the terminal, run the flutter devices command to verify that Flutter recognizes your connected Android device.

By default, Flutter uses the version of the Android SDK where your adb tool is based. If you want Flutter to use a different installation of the Android SDK, you must set the ANDROID_HOME environment variable to that specific installation directory.

Editor setup

Using our command-line tools, you can use any editor to develop Flutter applications.

We recommend using our IntelliJ plug-ins for a rich IDE experience supporting editing, running, and debugging Flutter apps. See IntelliJ Setup for detailed steps.

Next steps

Now, follow our Getting Started guide to run your first Flutter app on iOS and Android.