Coyote is a NuGet library and works on .NET Core which means it can be used on Windows, Linux and macOS.
- Visual Studio 2019 if you are on Windows.
- Visual Studio Code is handy to have on other platforms.
- Add the DGML editor feature of Visual Studio 2019.
Installing the NuGet package
The Coyote libraries can be easily installed by adding the
Microsoft.Coyote NuGet package and the
Microsoft.Coyote.Test NuGet package to
your C# project. You can then immediately start programming the Coyote API as shown in the
You can manually add Coyote to your C# project by using:
dotnet add <yourproject>.csproj package Microsoft.Coyote dotnet add <yourproject>.csproj package Microsoft.Coyote.Test
Installing the .NET Core 3.1 coyote tool
You can also install the
dotnet tool named
coyote for .NET Core 3.1 using the following command:
dotnet tool install --global Microsoft.Coyote.CLI
Now you can run the
coyote test tool without having to build Coyote from source. Type
--help to see if it is working. The dotnet tool install can also install coyote to a
folder if you prefer that.
You can remove the global
coyote tool by running the following command:
dotnet tool uninstall --global Microsoft.Coyote.CLI
Note: this command line tool is only for .NET Core. If you need a version of
runs on .NET Framework 4.7 or 4.8, this is installed from the
Microsoft.Coyote.Test package, and
you can run it from the bin folder of your Coyote application.
Building the samples
Clone the Coyote samples repo, then use the following
PowerShell command line from a Visual Studio 2019 Developer Command Prompt:
powershell -f build.ps1
The element ‘metadata’ in namespace nuspec.xsd has invalid child element ‘repository’…
If you get an error building the nuget package, you may need to download
a new version of
nuget.exe from https://www.nuget.org/downloads.