ILSpy/README.md

ILSpy

ILSpy is the open-source .NET assembly browser and decompiler.

Download: latest release | latest CI build (master) | Microsoft Store (RTM versions only)

Decompiler Frontends

Aside from the WPF UI ILSpy (downloadable via Releases, see also plugins), the following other frontends are available:

• Visual Studio 2022 ships with decompilation support for F12 enabled by default (using our engine v8.1).
• In Visual Studio 2019, you have to manually enable F12 support. Go to Tools / Options / Text Editor / C# / Advanced and check "Enable navigation to decompiled source"
• C# for Visual Studio Code ships with decompilation support as well. To enable, activate the setting "Enable Decompilation Support".
• Our Visual Studio 2022 extension marketplace
• Our Visual Studio 2017/2019 extension marketplace
• Our Visual Studio Code Extension repository | marketplace
• Our Linux/Mac/Windows ILSpy UI based on Avalonia - check out https://github.com/icsharpcode/AvaloniaILSpy
• Our ICSharpCode.Decompiler NuGet for your own projects
• Our dotnet tool for Linux/Mac/Windows - check out ILSpyCmd in this repository
• Our Linux/Mac/Windows PowerShell cmdlets in this repository

Features

• Decompilation to C# (check out the language support status)
• Whole-project decompilation
• Search for types/methods/properties (learn about the options)
• Hyperlink-based type/method/property navigation
• Base/Derived types navigation, history
• Assembly metadata explorer (feature walkthrough)
• BAML to XAML decompiler
• ReadyToRun binary support for .NET Core (see the tutorial)
• Extensible via plugins
• Additional features in DEBUG builds (for the devs)

License

ILSpy is distributed under the MIT License. Please see the About doc for details, as well as third party notices for included open-source libraries.

How to build

Windows:

• Make sure Windows PowerShell (at least version) 5.0 or PowerShell 7+ is installed.
• Clone the ILSpy repository using git.
• Execute git submodule update --init --recursive to download the ILSpy-Tests submodule (used by some test cases).
• Install Visual Studio (documented version: 17.8). You can install the necessary components in one of 3 ways:
  • Follow Microsoft's instructions for importing a configuration, and import the .vsconfig file located at the root of the solution.
  • Alternatively, you can open the ILSpy solution (ILSpy.sln) and Visual Studio will prompt you to install the missing components.
  • Finally, you can manually install the necessary components via the Visual Studio Installer. The workloads/components are as follows:
    • Workload ".NET Desktop Development". This workload includes the .NET Framework 4.8 SDK and the .NET Framework 4.7.2 targeting pack, as well as the .NET 8.0 SDK (ILSpy.csproj targets .NET 8.0, but we have net472 projects too). Note: The optional components of this workload are not required for ILSpy
    • Workload "Visual Studio extension development" (ILSpy.sln contains a VS extension project) Note: The optional components of this workload are not required for ILSpy
    • Individual Component "MSVC v143 - VS 2022 C++ x64/x86 build tools" (or similar)
      • The VC++ toolset is optional; if present it is used for editbin.exe to modify the stack size used by ILSpy.exe from 1MB to 16MB, because the decompiler makes heavy use of recursion, where small stack sizes lead to problems in very complex methods.
  • Open ILSpy.sln in Visual Studio.
    • NuGet package restore will automatically download further dependencies
    • Run project "ILSpy" for the ILSpy UI
    • Use the Visual Studio "Test Explorer" to see/run the tests
    • If you are only interested in a specific subset of ILSpy, you can also use
      • ILSpy.Wpf.slnf: for the ILSpy WPF frontend
      • ILSpy.XPlat.slnf: for the cross-platform CLI or PowerShell cmdlets
      • ILSpy.AddIn.slnf: for the Visual Studio plugin

Note: Visual Studio includes a version of the .NET SDK that is managed by the Visual Studio installer - once you update, it may get upgraded too. Please note that ILSpy is only compatible with the .NET 8.0 SDK and Visual Studio will refuse to load some projects in the solution (and unit tests will fail). If this problem occurs, please manually install the .NET 8.0 SDK from here.

Unix / Mac:

• Make sure .NET 8.0 SDK is installed.
• Make sure PowerShell is installed (formerly known as PowerShell Core)
• Clone the repository using git.
• Execute git submodule update --init --recursive to download the ILSpy-Tests submodule (used by some test cases).
• Use dotnet build ILSpy.XPlat.slnf to build the non-Windows flavors of ILSpy (.NET Core Global Tool and PowerShell Core).

How to contribute

• Report bugs
• If you want to contribute a pull request, please add https://github.com/icsharpcode/ILSpy/blob/master/BuildTools/pre-commit to your .git/hooks to prevent checking in code with wrong formatting. We use tabs and not spaces. The build server runs the same script, so any pull requests using wrong formatting will fail.

Current and past contributors.

Privacy Policy for ILSpy

ILSpy does not collect any personally identifiable information, nor does it send user files to 3rd party services. ILSpy does not use any APM (Application Performance Management) service to collect telemetry or metrics.