To install and run Flutter, your development environment must meet these minimum requirements:
- Operating Systems: macOS (64-bit)
- Disk Space: 2.8 GB (does not include disk space for IDE/tools).
- Tools: Flutter depends on these command-line tools being available in your environment.
Get the Flutter SDK
Download the following installation bundle to get the latest stable release of the Flutter SDK:
For other release channels, and older builds, see the SDK archive page.
Extract the file in the desired location, for example:
If you don’t want to install a fixed version of the installation bundle, you can skip steps 1 and 2. Instead, get the source code from the Flutter repo on GitHub with the following command:
You can also change branches or tags as needed. For example, to get just the stable version:
Add the tool to your path:
This command sets your variable for the current terminal window only. To permanently add Flutter to your path, see Update your path.
Optionally, pre-download development binaries:
The tool downloads platform-specific development binaries as needed. For scenarios where pre-downloading these artifacts is preferable (for example, in hermetic build environments, or with intermittent network availability), iOS and Android binaries can be downloaded ahead of time by running:
For additional download options, see .
You are now ready to run Flutter commands!
Note: To update an existing version of Flutter, see Upgrading Flutter.
Run flutter doctor
Run the following command to see if there are any dependencies you need to install to complete the setup (for verbose output, add the flag):
This command checks your environment and displays a report to the terminal window. The Dart SDK is bundled with Flutter; it is not necessary to install Dart separately. Check the output carefully for other software you might need to install or further tasks to perform (shown in bold text).
[-] Android toolchain - develop for Android devices • Android SDK at /Users/obiwan/Library/Android/sdk ✗ Android SDK is missing command line tools; download from https://goo.gl/XxQghQ
• Try re-installing or updating your Android SDK, visit https://flutter.dev/setup/#android-setup for detailed instructions.
The following sections describe how to perform these tasks and finish the setup process.
Once you have installed any missing dependencies, run the command again to verify that you’ve set everything up correctly.
Warning: The 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.
Flutter tool analytics are not sent on the very first run. To disable reporting, type . To display the current setting, type . If you opt out of analytics, an opt-out event is sent, and then no further information is sent by the Flutter tool.
Moreover, Flutter includes the Dart SDK, which may send usage metrics and crash reports to Google.
Update your path
You can update your PATH variable for the current session at the command line, as shown in Get the Flutter SDK. You’ll probably want to update this variable permanently, so you can run commands in any terminal session.
The steps for modifying this variable permanently for all terminal sessions are machine-specific. Typically you add a line to a file that is executed whenever you open a new window. For example:
- Determine the directory where you placed the Flutter SDK. You need this in Step 3.
- Open (or create) the file for your shell. Typing in your Terminal tells you which shell you’re using. If you’re using Bash, edit or . If you’re using Z shell, edit . If you’re using a different shell, the file path and filename will be different on your machine.
Add the following line and change to be the path where you cloned Flutter’s git repo:
- Run to refresh the current window, or open a new terminal window to automatically source the file.
Verify that the directory is now in your PATH by running:
Verify that the command is available by running:
Note: As of Flutter’s 1.19.0 dev release, the Flutter SDK contains the command alongside the command so that you can more easily run Dart command-line programs. Downloading the Flutter SDK also downloads the compatible version of Dart, but if you’ve downloaded the Dart SDK separately, make sure that the Flutter version of is first in your path, as the two versions might not be compatible. The following command (on macOS, linux, and chrome OS), tells you whether the and commands originate from the same directory and are therefore compatible. (Some versions of Windows support a similar command.)
As shown above, the two commands don’t come from the same directory. Update your path to use commands from before commands from (in this case). After updating your shell for the change to take effect, running the or command again should show that the and commands now come from the same directory.
To learn more about the command, run from the command line, or see the dart tool page.
macOS supports developing Flutter apps in iOS, Android, and the web (technical preview release). Complete at least one of the platform setup steps now, to be able to build and run your first Flutter app.
To develop Flutter apps for iOS, you need a Mac with Xcode installed.
- Install the latest stable version of Xcode (using web download or the Mac App Store).
Configure the Xcode command-line tools to use the newly-installed version of Xcode by running the following 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.
- Make sure the Xcode license agreement is signed by either opening Xcode once and confirming or running from the command line.
Versions older than the latest stable version may still work, but are not recommended for Flutter development. Using old versions of Xcode to target bitcode is not supported, and is likely not to work.
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:
On your Mac, find the Simulator via Spotlight or by using the following command:
- 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.
- Depending on your development machine’s screen size, simulated high-screen-density iOS devices might overflow your screen. Grab the corner of the simulator and drag it to change the scale. You can also use the Window > Physical Size or Window > Pixel Accurate options if your computer’s resolution is high enough.
- If you are using a version of XCode older than 9.1, you should instead set the device scale in the Window > Scale menu.
Create and run a simple Flutter app
To create your first Flutter app and test your setup, follow these steps:
Create a new Flutter app by running the following from the command line:
A directory is created, containing Flutter’s starter app. Enter this directory:
To launch the app in the Simulator, ensure that the Simulator is running and enter:
Deploy to iOS devices
To deploy your Flutter app to a physical iOS device you need the third-party CocoaPods dependency manager and an Apple Developer account. You’ll also need to set up physical device deployment in Xcode.
Install and set up CocoaPods by running the following commands:
Follow the Xcode signing flow to provision your project:
- Open the default Xcode workspace in your project by running in a terminal window from your Flutter project directory.
- Select the device you intend to deploy to in the device drop-down menu next to the run button.
- Select the project in the left navigation panel.
- In the target settings page, make sure your Development Team is selected. The UI varies depending on your version of Xcode.
- For Xcode 10, look under General > Signing > Team.
- For Xcode 11 and newer, look under Signing & Capabilities > Team.
When you select a team, Xcode creates and downloads a Development Certificate, registers your device with your account, and creates and downloads a provisioning profile (if needed).
- To start your first iOS development project, you might need to sign into Xcode with your Apple ID. Development and testing is supported for any Apple ID. Enrolling in the Apple Developer Program is required to distribute your app to the App Store. For details about membership types, see Choosing a Membership.
The first time you use an attached physical device for iOS development, you need to trust both your Mac and the Development Certificate on that device. Select in the dialog prompt when first connecting the iOS device to your Mac.
Then, go to the Settings app on the iOS device, select General > Device Management and trust your Certificate. For first time users, you may need to select General > Profiles > Device Management instead.
If automatic signing fails in Xcode, verify that the project’s General > Identity > Bundle Identifier value is unique.
Start your app by running or clicking the Run button in Xcode.
Note: Flutter relies on a full installation of Android Studio to supply its Android platform dependencies. However, you can write your Flutter apps in a number of editors; a later step discusses that.
Install Android Studio
- Download and install Android Studio.
- Start Android Studio, and go through the ‘Android Studio Setup Wizard’. This installs the latest Android SDK, Android SDK Command-line Tools, and Android SDK Build-Tools, which are required by Flutter when developing for Android.
Set up your Android device
To prepare to run and test your Flutter app on an Android device, you need an Android device running Android 4.1 (API level 16) or higher.
- Enable Developer options and USB debugging on your device. Detailed instructions are available in the Android documentation.
- Windows-only: Install the Google USB Driver.
- Using a USB cable, plug your phone into your computer. If prompted on your device, authorize your computer to access your device.
- In the terminal, run the command to verify that Flutter recognizes your connected Android device. By default, Flutter uses the version of the Android SDK where your tool is based. If you want Flutter to use a different installation of the Android SDK, you must set the environment variable to that installation directory.
Set up the Android emulator
To prepare to run and test your Flutter app on the Android emulator, follow these steps:
- Enable VM acceleration on your machine.
- Launch Android Studio, click the AVD Manager icon, and select Create Virtual Device…
- In older versions of Android Studio, you should instead launch Android Studio > Tools > Android > AVD Manager and select Create Virtual Device…. (The Android submenu is only present when inside an Android project.)
- If you do not have a project open, you can choose Configure > AVD Manager and select Create Virtual Device…
- Choose a device definition and select Next.
- Select one or more system images for the Android versions you want to emulate, and select Next. An x86 or x86_64 image is recommended.
- Under Emulated Performance, select Hardware - GLES 2.0 to enable hardware acceleration.
Verify the AVD configuration is correct, and select Finish.
For details on the above steps, see Managing AVDs.
- In Android Virtual Device Manager, click Run in the toolbar. The emulator starts up and displays the default canvas for your selected OS version and device.
Flutter has early support for building web applications using the channel of Flutter. To add support for web development, follow these instructions when you’ve completed the setup above.
Set up your preferred editor.