Search categories, packages and repositories

Package detailsv0.2.0

squirrel

Create installable desktop apps

30-day downloads
53
Likes
40
Pub points
35

Install package

flutter pub add squirrel

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

Squirrel is a Flutter package that enables developers to create installable desktop applications for Windows, Linux, and macOS. It simplifies the process of packaging and publishing Flutter apps as native desktop installers, handling updates, file associations, and system integration. By leveraging Squirrel's robust update mechanism, apps can automatically check for and apply updates, ensuring users always have the latest version. The package integrates seamlessly with Flutter workflows and supports cross-platform deployment with minimal configuration.

Use cases

  • Building distributable desktop apps
  • Automating app updates
  • Creating installer packages for multiple OS
  • Integrating native desktop features
  • Publishing Flutter apps to end users
  • Enabling silent background updates

Key features

  • Cross-platform desktop support
  • Automatic update management
  • Installer generation for Windows, Linux, and macOS
  • Seamless integration with Flutter
  • Support for delta updates
  • Simple CLI-based setup

Suitable for

  • Desktop app developers
  • Publishers of cross-platform desktop apps
  • Teams needing automatic updates
  • Developers targeting Windows, Linux, and macOS
  • Projects requiring native installer behavior

Considerations

  • Requires platform-specific setup steps
  • Limited to desktop platforms
  • May need additional configuration for complex workflows
  • Not suitable for mobile or web deployment
  • Depends on external Squirrel tools for full functionality

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Squirrel.Windows for Flutter

This package creates desktop installers for Windows 7+ as well as implements auto-update, via Squirrel.Windows, an installer technology used originally as part of the Atom text editor and now deployed on millions of machines via projects such as Slack, Discord, GitHub Desktop, as well as hundreds of other projects.

Getting Started (alpha)

Run the following command, it will tell you what to do next (put an extra block in your pubspec.yaml).

flutter pub run squirrel:installer_windows

Now take that folder that it generates and upload that to Cloudfront / Fastly / any static CDN. Bingo bongo, you're done!

How do I update? (alpha)

This is WIP, but the extremely lazy answer is, run this command on startup via Process.run:

$WHATEVER_FOLDER_MY_EXECUTABLE_IS_IN/../Update.exe --update https://wherever-i-put-my-update-folder

` Before this package reaches 1.0, it will have a proper API to do this!

Where can I read more, because this README is extremely lacking in content! (I know)

Read the Squirrel documentation - note that some of the names in this package have been clarified / simplified vs. what they are called in Squirrel.Windows, read installer_windows.dart in this package to see how things map.

Categories

Dependencies

Dependency list 3 items

Source repository

Projects using this package

No data available yet.