CheatPress

Flutter Cross-platform UI toolkit

Version 3.47 · source

Flutter, Postcard, light preview Light · Postcard 102 × 152 mm · PDF Flutter, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF Flutter, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
Flutter, A5, light preview Light · A5 148 × 210 mm · PDF Flutter, A5, dark preview Dark · A5 148 × 210 mm · PDF Flutter, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
Flutter, A4, light preview Light · A4 210 × 297 mm · PDF Flutter, A4, dark preview Dark · A4 210 × 297 mm · PDF Flutter, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
Flutter, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF Flutter, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF Flutter, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
Flutter, A3, light preview Light · A3 297 × 420 mm · PDF Flutter, A3, dark preview Dark · A3 297 × 420 mm · PDF Flutter, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
Flutter, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF Flutter, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF Flutter, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
Flutter, Letter, light preview Light · Letter 8.5 × 11 in · PDF Flutter, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF Flutter, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
Flutter, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF Flutter, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF Flutter, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

flutter create <name>
New project
flutter doctor
Check your setup
flutter devices
List targets
flutter run
Run with hot reload
flutter pub add <pkg>
Add a package
flutter test
Run tests
flutter analyze
Lint the code
flutter build apk
Release build

Concepts

  1. Edit Dart code
  2. Hot reload keeps state
  3. Hot restart fresh state
  4. Release apk / ipa / web

Project

flutter create <name>
Create a new app
flutter create --platforms=android,web .
Create into current dir for chosen platforms
flutter create --template=package <name>
Create a Dart package
Other templates: plugin, module, skeleton.
flutter create --org <com.example> <name>
Set the reverse-domain org id
flutter clean
Delete build/ and .dart_tool/
flutter gen-l10n
Generate localization classes

Run and debug

flutter run
Run the app on the selected device
flutter run -d <device-id>
Pick a device
flutter run -d all
Run on every connected device
flutter run -t <file.dart>
Use another entrypoint
flutter run --release
Run an optimized build
flutter run --profile
Profile performance on a real device
flutter run --flavor <name>
Build a flavor / scheme
flutter run --dart-define=<K>=<V>
Pass a compile-time constant
flutter attach
Attach to an app already running
flutter logs
Stream device logs

In a run session

r
Hot reload
R
Hot restart
q
Quit and stop the app
h
List all session commands
d
Detach, leave the app running
p
Toggle the widget debug overlay
P
Toggle performance overlay
w
Dump the widget hierarchy

Devices

flutter devices
List connected devices
flutter emulators
List available emulators
flutter emulators --launch <id>
Start an emulator
flutter config --enable-<platform>-desktop
Enable a desktop platform
Platforms: linux, windows, macos; web uses --enable-web.

Packages

flutter pub get
Fetch dependencies
flutter pub add <pkg>
Add a dependency
flutter pub add dev:<pkg>
Add a dev dependency
flutter pub remove <pkg>
Remove a dependency
flutter pub upgrade
Upgrade within constraints
flutter pub upgrade --major-versions
Raise constraints to latest majors
flutter pub outdated
Show packages with newer versions
flutter pub deps
Print the dependency tree
flutter pub run build_runner build
Run code generation

Test and analyze

flutter test
Run all tests in test/
flutter test <path/to/file_test.dart>
Run one test file
flutter test --plain-name <text>
Run tests by name substring
flutter test --name <regex>
Run tests matching a regex
flutter test --coverage
Write coverage/lcov.info
flutter test --update-goldens
Regenerate golden images
flutter test integration_test -d <id>
Run integration tests on a device
flutter analyze
Static analysis
flutter analyze --fatal-infos
Fail on infos too (CI)
dart format .
Format all Dart files
dart fix --apply
Apply automated lint fixes

Build

flutter build apk
Android APK
flutter build apk --split-per-abi
One APK per CPU architecture
flutter build appbundle
Android App Bundle for Play
flutter build ios
iOS build (macOS only)
flutter build ipa
iOS archive for the App Store
flutter build web
Web build into build/web
flutter build linux
Linux desktop build
flutter build windows
Windows desktop build
flutter build macos
macOS desktop build
flutter build <target> --obfuscate --split-debug-info=<dir>
Obfuscate Dart symbols
flutter build <target> --build-name=<x.y.z> --build-number=<n>
Override version

SDK and setup

flutter doctor
Check toolchain and platforms
flutter doctor -v
Detailed doctor output
flutter doctor --android-licenses
Accept Android SDK licenses
flutter --version
Show SDK, engine, Dart versions
flutter upgrade
Upgrade the SDK
flutter channel
List channels
flutter channel <stable|beta|main>
Switch channel
flutter help <command>
Help for one command

Recipes

New app, verify, run
flutter create --org com.example my_appcd my_appflutter analyze && flutter testflutter run -d chrome
Release APK for sideloading
flutter cleanflutter pub getflutter build apk --release --split-per-abi# output: build/app/outputs/flutter-apk/
Play Store bundle with a build number
flutter build appbundle --release \  --build-name=1.2.0 --build-number=42# output: build/app/outputs/bundle/release/
Coverage report
flutter test --coveragegenhtml coverage/lcov.info -o coverage/html# genhtml comes from lcov