Squirrel is both a set of tools and a library, to completely manage both installation and updating your Desktop Windows application, written in either C# or any other language (i.e., Squirrel can manage native C++ applications).

Squirrel uses NuGet packages to create installation and update packages, which means that you probably already know most of what you need to create an installer.

What Do We Want?

Windows apps should be as fast and as easy to install and update as apps like Google Chrome. From an app developer's side, it should be really straightforward to create an installer for my app, and publish updates to it, without having to jump through insane hoops.

Integrating an app to use Squirrel should be extremely easy, provide a client API, and be developer friendly.
Packaging is really easy, can be automated, and supports delta update packages.
Distributing should be straightforward, use simple HTTP updates, and provide multiple "channels" (a-la Chrome Dev/Beta/Release).
Installing is Wizard-Free™, with no UAC dialogs, does not require reboot, and is .NET Framework friendly.
Updating is in the background, doesn't interrupt the user, and does not require a reboot.

Refer to our full list of goals for integrating, packaging, distributing, installing, and updating.

1 Getting Started

Section 1, Getting Started, will step through the integration of Squirrel.Windows for a basic c# application. The steps for using Squirrel.Windows with your application include the following:

1.1 Integrating - integrating Squirrel update into your application.
1.2 Packaging - packaging application files and preparing them for release.
1.3 Distributing - providing install and update files for users.
1.4 Installing - process of initial installation of your application.
1.5 Updating - process of updating an existing install.

2 Advanced Usage

Section 2 Advanced Usage, explores specific advanced topics for using Squirrel, including the following:

2.1 More Integrating - details on integrating Squirrel in MyApp along with advanced topics (e.g., Debugging, Custom Squirrel Events).
2.2 More Packaging - packaging meta data details and advanced topics (e.g., Automating Packaging, Delta Packages, Application Signing).
2.3 More Distributing - additional distribution options (e.g., Microsoft IIS, GitHub, Amazon S3).
2.4 More Installing - detailed install steps and advanced topics (e.g., Machine-wide Installs, Loading GIF).
2.5 More Updating - detailed update steps.

3 Contributing

Why not give back and help make Squirrel even better by contributing to the project.

4 FAQ

Have a question? Review the Frequently Asked Questions (FAQ) document.

5 Copyright and Usage

See COPYING for details on copyright and usage of the Squirrel.Windows software.

Next: 1 Getting Started

Languages

C# 73.2%

Rust 22.3%

C++ 1.6%

TypeScript 1.1%

C 1%

Other 0.6%