Skip to content

Install Sleet

Sleet is a .NET tool. This page covers the ways to install and run it, and how to pin a version for builds.

Requirements

The Sleet .NET tool needs the .NET 8 SDK or later. It runs on Windows, Linux, and macOS. Check your SDK version with:

dotnet --version

If you can't install .NET, use Sleet.exe on Windows instead.

Global tool

A global tool puts the sleet command on your PATH for your user account. This is the usual choice on a workstation.

dotnet tool install -g sleet

Check that it works:

sleet --version

On Linux and macOS, global tools are installed to $HOME/.dotnet/tools. If the shell can't find sleet, add that folder to your PATH.

Update or remove the tool with:

dotnet tool update -g sleet
dotnet tool uninstall -g sleet

Pin a version in CI

In build scripts, pin the major version. A new major release can then never change your build without you knowing:

dotnet tool install -g sleet --version "7.*"

Check the release notes before you move to a new major version.

Local tool

A local tool manifest pins an exact Sleet version for a repository, so every developer and build uses the same one.

dotnet new tool-manifest
dotnet tool install sleet

Commit the .config/dotnet-tools.json file this creates. After a clone, restore the tools and run Sleet through dotnet:

dotnet tool restore
dotnet sleet --version

Every sleet command in these docs also works as dotnet sleet. See Microsoft's guide to local tools for more.

Run without installing

With the .NET 10 SDK or later, dnx downloads Sleet and runs it in one step:

dnx sleet createconfig --azure

Sleet.exe for Windows

The SleetExe package contains Sleet.exe, a self-contained build for Windows x64. It doesn't need .NET to be installed.

  1. Download the package from NuGet.org.
  2. Open the .nupkg file as a zip file.
  3. Extract tools/Sleet.exe to a folder and run it.

The commands are the same as for the .NET tool. Starting with Sleet 8.0, adding the SleetExe package to a project also sets the $(Sleet) MSBuild property to the full path of Sleet.exe:

<Target Name="PublishToFeed">
  <Exec Command="&quot;$(Sleet)&quot; push nupkgs --skip-existing" />
</Target>

SleetLib for .NET code

The SleetLib package contains the library behind the Sleet CLI. Use it to create and update feeds from your own .NET code. See SleetLib.

dotnet add package SleetLib

Next steps

Create a feed on Azure, Amazon S3, or a local folder.