flutter_full_restart 3.0.1

flutter_full_restart: ^3.0.1 copied to clipboard

Restart a Flutter app from Dart, on every platform.
Built and maintained by Azerosoft.

flutter_full_restart restarts your app the way a user would by closing and reopening it.

await FullRestart.restart(); // kill the process and cold-start the app

_{The example app on iOS and Android.}

Contents #

• Features
• Platform support
• Requirements
• Installation
• Usage
• Read links with app_links
• API overview
• How it works
• Platform setup
• Troubleshooting
• Example app
• Tested with
• Contributing
• About Azerosoft

Features #

• Full restart. Kills the process and cold-starts the app, exactly like closing and reopening it. Dart state, plugins and native state all start over.
• Every platform. Android, iOS, macOS, Web (including WebAssembly), Windows and Linux.
• Almost no setup. Only iOS needs one entry in Info.plist, see iOS setup. Without it a restart does nothing and a yellow warning in the debug console tells you what to add.
• Swift Package Manager ready. iOS and macOS work with Swift Package Manager and CocoaPods, privacy manifest included.
• Never throws. Every call returns true or false, so a failed restart never crashes your app. The reason for a false is printed to the debug console in yellow.

Platform support #

Works on Android, iOS, macOS, Web, Windows and Linux.

• On iOS, a full restart needs the URL scheme described in iOS setup. No other platform needs any setup.
• On iOS and macOS, the plugin works with both Swift Package Manager and CocoaPods.
• On the web, a full restart reloads the page.

Requirements #

Installation #

flutter pub add flutter_full_restart

On iOS, register the URL scheme described in iOS setup. No other platform needs any setup.

Usage #

Restart from anywhere:

import 'package:flutter_full_restart/flutter_full_restart.dart';

await FullRestart.restart();

It kills the process and launches the app again. Use it after installing an update, switching the language or the backend environment, or anything else that needs a clean start.

When the restart cannot be started, restart() returns false, nothing happens in the app, and the reason is printed to the debug console in yellow:

[flutter_full_restart] Full restart is not available on iOS: Info.plist does not register the bundle identifier as a URL scheme.

Read links with app_links or a similar package #

On iOS, a full restart reopens the app through an empty link (<bundle id>://). Flutter's own deep linking never sees it, but packages that read links themselves, such as app_links, report it after the restart. Skip it with FullRestart.isRestartLink:

AppLinks().uriLinkStream.listen((Uri uri) {
  if (FullRestart.isRestartLink(uri)) return; // the link of a full restart
  router.go(uri.path); // https://example.com/product/42 -> /product/42
});

Your other links, with or without the app running, arrive as usual.

API overview #

The full API reference is on pub.dev.

How it works #

• Android: starts the launcher activity in a new task and exits the process.
• iOS: reopens the app through its own URL scheme (<bundle id>://) and exits the process. Without the URL scheme nothing happens and a yellow warning is printed.
• macOS: launches a new instance of the app bundle and exits.
• Windows and Linux: start a new instance of the executable with the same arguments and exit. The new instance waits until the old one has exited, so apps that allow only one instance restart too.
• Web: reloads the page.

Platform setup #

iOS setup #

iOS lets an app reopen itself only through its own URL scheme, so register your bundle identifier as a URL scheme in ios/Runner/Info.plist:

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLName</key>
    <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
    </array>
  </dict>
</array>

A full restart then reopens the app through that scheme and exits the old process, like on the other platforms. The user sees the home screen for a moment, then the app opens again.

Without this entry, FullRestart.restart() returns false, the app keeps running as it is, and the debug console shows a yellow warning with the snippet above.

The plugin keeps the URL it reopens the app with away from Flutter's deep linking, so your router never sees it. If you read links with a package such as app_links, skip it as shown in Read links with app_links. Your app's other URLs are not affected.

Because the whole process restarts, your code in AppDelegate runs again and downloaded Shorebird patches are applied.

Apple discourages apps from quitting on their own. Trigger a full restart only in response to a user action, such as switching the language or the backend environment.

Swift Package Manager #

Nothing to configure. When Swift Package Manager is enabled (the default in recent Flutter versions), Flutter uses the plugin's Package.swift on iOS and macOS. Otherwise it falls back to CocoaPods. Both include a privacy manifest (PrivacyInfo.xcprivacy).

Android #

The Android side is written in Java on purpose: it builds with any Android Gradle Plugin from 7.x to 9.x, with or without the Kotlin Gradle Plugin. No setup is needed, and downloaded Shorebird patches are applied after a restart.

Troubleshooting #

Example app #

The example app shows the time the Dart session started, which changes after every full restart. It runs on all six platforms.

cd example
flutter run

Tested with #

The minimum and maximum versions this package was tested with, as of October 2026. Versions in between were not all tested one by one, but they are expected to work as well. On every push, GitHub Actions runs the tests and builds the example for all platforms, once with Flutter 3.22.3 and once with the latest stable release.

Flutter and Dart #

Android #

iOS #

macOS #

Windows #

Linux #

Web #

Tried by hand #

The example app was also started on these systems and the restarts were tried by hand:

The Windows and Linux C++ unit tests also run on every push, on Windows Server 2022 and 2025 and on Ubuntu 24.04 (x64).

Contributing #

Bug reports, ideas and pull requests are welcome. Please read the contributing guide and our code of conduct first.

• Report a bug
• Request a feature
• Report a security issue (privately, please)

About Azerosoft #

Azerosoft is a design and development studio from Baku, Azerbaijan. We design interfaces and build websites, web and mobile apps, backends, CRM systems and 2D games. We use our packages in our own projects and maintain them for everyone.

• Website: azerosoft.com
• All our packages: pub.dev/publishers/azerosoft.com
• GitHub: github.com/azerosoft
• Email: hello@azerosoft.com

Building something with Flutter? Tell us about your project.

License #

Released under the MIT License.