From Squirrel

Applies to

Windows

MacOS

Linux

Migrate from Squirrel.Windows or Clowd.Squirrel to Velopack.

Here are the general steps needed:

Replace the Squirrel.Windows or Clowd.Squirrel nuget package with the latest Velopack NuGet Package.
Install the vpk command line tool, as this is what you'll use to build Velopack releases.
```
dotnet tool install -g vpk
```
tip
Make sure you are using the same version of vpk and the Velopack package, this is the only officially supported configuration.

You will need to replace Squirrel.SquirrelAwareApp at the beginning of your app to Velopack.VelopackApp.Build().Run().

Shortcuts [Read more] and registry entries are managed automatically for you in Velopack, so if you are currently doing this in SquirrelAwareApp hooks they should be removed. For example, if your hooks were this before:

public static void Main(string[] args)
{
    SquirrelAwareApp.HandleEvents(
        onInitialInstall: OnAppInstall,
        onAppUninstall: OnAppUninstall,
        onEveryRun: OnAppRun);
}

private static void OnAppInstall(SemanticVersion version, IAppTools tools)
{
    tools.CreateShortcutForThisExe(ShortcutLocation.StartMenu | ShortcutLocation.Desktop);
}

private static void OnAppUninstall(SemanticVersion version, IAppTools tools)
{
    tools.RemoveShortcutForThisExe(ShortcutLocation.StartMenu | ShortcutLocation.Desktop);
}

private static void OnAppRun(SemanticVersion version, IAppTools tools, bool firstRun)
{
    if (firstRun) MessageBox.Show("Thanks for installing my application!");
}

Then you would migrate to the following code, removing the shortcut hooks:

public static void Main(string[] args)
{
    // Thank the user for installing the app on first run.
    // Note that the MessageBox class below comes from WinForms or WPF.
    VelopackApp.Build()
        .WithFirstRun(v => MessageBox.Show("Thanks for installing my application!"))
        .Run();
}

Velopack hooks no longer support manual creation of shortcuts. Rather these are automatically created/removed for you as part of the installer.
Velopack requires the application to be restarted to apply updates. The previous APIs applied the downloaded updates before triggering the restart.
The concept of SquirrelAwareApp no longer exists, so if you've added any attributes, assembly manifest entries, or other files to indicate that your binary is now aware, you can remove that. Every Velopack package has exactly one "VelopackApp" binary, which must implement the above code at the top of Main. By default, Velopack will search for a binary in {packDir}\{packId}.exe. If your main VelopackApp exe is named differently, you should provide the name with the --mainExe yourApp.exe argument.
The "RELEASES" file is no longer a format that Velopack uses, but it will produce one when building packages on windows with the default channel (eg. no channel argument provided). Instead, Velopack will produce releases.{channel}.json files, which should be treated in the same way. If you are wishing for a legacy windows app to migrate to Velopack, you should publish a release (omitting the --channel arg) and upload both the RELEASES file and the releases.win.json file which is produced by Velopack to your update feed.
In general, the command line supports all of the same features, but argument names or commands may have changed. Velopack no longer supports taking a .nupkg which was created by dotnet or nuget.exe. You should compile/publish your app, and provide your compiler output to vpk pack instead. A very simple example might look like this
```
dotnet publish --self-contined -r win-x64 -o publish
vpk pack -u YourAppId -v 1.0.0 -p publish -e yourMainBinary.exe
```
Please review the vpk command line help for more details:
```
vpk -h
```
In your installed app, there are no longer app-1.0.0 folders, and in a freshly installed app there will not be a YourApp.exe in the root of the application. Changing the path of the application (eg. app-1.0.0 and app-1.0.1) like Squirrel does is very bad, it breaks a lot of things in Windows. Firewall rules, antivirus issues, GPU preferences, tray icon pinning, and more. Maintaining the exe location in the same position after each update fixes many issues so velopack will always store your program at {root}\current\YourApp.exe. The first time your Squirrel app downloads a Velopack update, the Velopack updater will perform an app migration, it will look for shortcuts in all the usual/default locations and clean them up / repair them to point to the new location. If you previously had file associations or shortcuts outside of default locations pointing to {root}\YourApp.exe these will need to be updated since that file will no longer exist in new installs.

API differences with Clowd.Squirrel

This list is not exhaustive and may change over time. If you have a specific question, please ask in the Velopack Discord. For many of these a simple find/replace in your codebase should be sufficient, however, these are merely guidelines and you should review the

ReleaseEntry class is replaced by VelopackAsset
UpdateManager is no longer disposable. Remove any using statements.
UpdateManager.IsInstalledApp property is renamed to UpdateManager.IsInstalled
UpdateManager.CheckForUpdate() method is renamed to UpdateManager.CheckForUpdatesAsync()
UpdateInfo.CurrentlyInstalledVersion is replaced by checking the UpdateInfo.BaseRelease
UpdateInfo.ReleasesToApply no longer exists, depending on your usage this is replace by either UpdateInfo.TargetFullRelease or UpdateInfo.DeltasToTarget
UpdateInfo.FutureReleaseEntry is replaced by UpdateInfo.TargetFullRelease
UpdateInfo.Create() no longer exists, use the constructor directly new UpdateInfo()
UpdateManager.DownloadReleases() is replaced by UpdateManager.DownloadUpdatesAsync()

API differences with Clowd.Squirrel​

API differences with Clowd.Squirrel