flet debug

Run a Flet Python app in debug mode on a specified platform (desktop, web, mobile).

Usage

flet debug [-h] [-v] [--device-id DEVICE_ID] [--show-devices] [--release] [--route ROUTE] [--arch TARGET_ARCH [TARGET_ARCH ...]] [--exclude EXCLUDE [EXCLUDE ...]] [--clear-cache] [--project PROJECT_NAME] [--description DESCRIPTION] [--product PRODUCT_NAME] [--org ORG_NAME] [--bundle-id BUNDLE_ID] [--company COMPANY_NAME] [--copyright COPYRIGHT] [--android-adaptive-icon-background ANDROID_ADAPTIVE_ICON_BACKGROUND] [--splash-color SPLASH_COLOR] [--splash-dark-color SPLASH_DARK_COLOR] [--no-web-splash] [--no-ios-splash] [--no-android-splash] [--ios-team-id IOS_TEAM_ID] [--ios-export-method IOS_EXPORT_METHOD] [--ios-provisioning-profile IOS_PROVISIONING_PROFILE] [--ios-signing-certificate IOS_SIGNING_CERTIFICATE] [--base-url BASE_URL] [--web-renderer {auto,canvaskit,skwasm}] [--route-url-strategy {path,hash}] [--pwa-background-color PWA_BACKGROUND_COLOR] [--pwa-theme-color PWA_THEME_COLOR] [--no-wasm] [--no-cdn] [--split-per-abi] [--compile-app] [--compile-packages] [--cleanup-app] [--cleanup-app-files [CLEANUP_APP_FILES ...]] [--cleanup-packages] [--cleanup-package-files [CLEANUP_PACKAGE_FILES ...]] [--flutter-build-args [FLUTTER_BUILD_ARGS ...]] [--source-packages SOURCE_PACKAGES [SOURCE_PACKAGES ...]] [--info-plist INFO_PLIST [INFO_PLIST ...]] [--macos-entitlements MACOS_ENTITLEMENTS [MACOS_ENTITLEMENTS ...]] [--android-features ANDROID_FEATURES [ANDROID_FEATURES ...]] [--android-permissions ANDROID_PERMISSIONS [ANDROID_PERMISSIONS ...]] [--android-meta-data ANDROID_META_DATA [ANDROID_META_DATA ...]] [--permissions {location,camera,microphone,photo_library} [{location,camera,microphone,photo_library} ...]] [--deep-linking-scheme DEEP_LINKING_SCHEME] [--deep-linking-host DEEP_LINKING_HOST] [--android-signing-key-store ANDROID_SIGNING_KEY_STORE] [--android-signing-key-store-password ANDROID_SIGNING_KEY_STORE_PASSWORD] [--android-signing-key-password ANDROID_SIGNING_KEY_PASSWORD] [--android-signing-key-alias ANDROID_SIGNING_KEY_ALIAS] [--build-number BUILD_NUMBER] [--build-version BUILD_VERSION] [--module-name MODULE_NAME] [--template TEMPLATE] [--template-dir TEMPLATE_DIR] [--template-ref TEMPLATE_REF] [--show-platform-matrix] [--no-rich-output] [--yes] [--skip-flutter-doctor] [{macos,linux,windows,web,ios,android}] [python_app_path]

Positional Arguments

  • **platform**: Target platform.
  • * Possible values: android, ios, linux, macos, web, windows. * Required: No.
  • **python_app_path**: Path to Flet Python program directory.
  • * Default: .

    Options

  • **--android-adaptive-icon-background**: Background color for Android adaptive icons.
  • **--android-features**: List of =True|False for AndroidManifest.xml.
  • **--android-meta-data**: List of = app meta-data for AndroidManifest.xml.
  • **--android-permissions**: List of =True|False for AndroidManifest.xml.
  • **--android-signing-key-alias**: Android signing key alias.
  • * Default: upload
  • **--android-signing-key-password**: Android signing key password.
  • **--android-signing-key-store**: Path to Android .jks keystore file.
  • **--android-signing-key-store-password**: Android signing store password.
  • **--arch**: Target CPU architectures for macOS and Android builds.
  • * Example: --arch arm64 x64
  • **--base-url**: Base URL for serving the app (web only).
  • **--build-number**: Build number (integer).
  • **--build-version**: Build version string (e.g., x.y.z).
  • **--bundle-id**: Bundle ID for the application (iOS, Android, macOS, Linux).
  • * Example: com.mycompany.app-name
  • **--cleanup-app**: Remove unnecessary app files during packaging.
  • **--cleanup-app-files**: Globs to delete extra app files/directories.
  • **--cleanup-package-files**: Globs to delete extra package files/directories.
  • **--cleanup-packages**: Remove unnecessary package files during packaging.
  • **--clear-cache**: Clear build cache before starting.
  • **--company**: Company name for app dialogs.
  • **--compile-app**: Pre-compile app's .py files to .pyc.
  • **--compile-packages**: Pre-compile site packages' .py files to .pyc.
  • **--copyright**: Copyright text for app dialogs.
  • **--deep-linking-host**: Deep linking URL host (iOS, Android).
  • **--deep-linking-scheme**: Deep linking URL scheme (e.g., myapp) (iOS, Android).
  • **--description**: Short description of the application.
  • **--device-id**: Device ID for iOS and Android builds.
  • * Aliases: -d
  • **--exclude**: Files and/or directories to exclude from the package.
  • **--flutter-build-args**: Additional arguments for flutter build command.
  • **--help**: Show this help message and exit.
  • * Aliases: -h
  • **--info-plist**: Key-value pairs for Info.plist (macOS, iOS IPA).
  • **--ios-export-method**: Export method for iOS app bundle.
  • * Default: debugging
  • **--ios-provisioning-profile**: Provisioning profile name or UUID for iOS signing.
  • **--ios-signing-certificate**: Signing certificate name or SHA-1 hash for iOS signing.
  • **--ios-team-id**: Apple developer team ID for iOS signing (IPA only).
  • **--macos-entitlements**: Key-value pairs for macOS entitlements.
  • **--module-name**: Python module name with app entry point.
  • **--no-android-splash**: Disable splash screen on Android.
  • **--no-cdn**: Disable loading CanvasKit, Pyodide, and fonts from CDN.
  • **--no-ios-splash**: Disable splash screen on iOS.
  • **--no-rich-output**: Prefer plain text output (useful on Windows).
  • **--no-wasm**: Disable WASM target for web build (web only).
  • **--no-web-splash**: Disable splash screen on web.
  • **--org**: Organization name (reverse domain notation) for bundle IDs and signing.
  • **--permissions**: Pre-defined cross-platform permissions.
  • * Possible values: camera, location, microphone, photo_library.
  • **--product**: Display name of the app.
  • **--project**: Project name for executable/bundle.
  • **--pwa-background-color**: Initial background color for web app (web only).
  • **--pwa-theme-color**: Default UI color for web app (web only).
  • **--release**: Build the app in release mode.
  • **--route**: Route to open the app on (web, iOS, Android).
  • **--route-url-strategy**: Base URL path strategy for web app.
  • * Possible values: hash, path.
  • **--show-devices**: Show connected devices for iOS and Android.
  • **--show-platform-matrix**: Display build platform matrix and exit.
  • **--skip-flutter-doctor**: Skip running Flutter doctor on failed builds.
  • **--source-packages**: List of Python packages to install from source distributions.
  • **--splash-color**: Background color of app splash screen (iOS, Android, web).
  • **--splash-dark-color**: Background color in dark mode for app splash screen (iOS, Android, web).
  • **--split-per-abi**: Split APKs per ABIs (Android only).
  • **--template**: Directory or git URL for Flutter bootstrap template.
  • **--template-dir**: Relative path to a Flutter bootstrap template in a repository.
  • **--template-ref**: Branch, tag, or commit ID for the template repository.
  • **--verbose**: Enable verbose output.
  • * Aliases: -v
  • **--web-renderer**: Flutter web renderer to use (web only).
  • * Possible values: auto, canvaskit, skwasm.
  • **--yes**: Answer yes to all prompts (e.g., dependency installation).