leeseett / ILSpy

.NET Decompiler

ILSpy

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

Download: latest release | latest CI build (master)

CI Build Nuget Feed (master): https://ci.appveyor.com/nuget/ilspy-masterfeed

Decompiler Frontends

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

• Visual Studio 2017 extension marketplace
• Visual Studio Code Extension repository | marketplace
• ICSharpCode.Decompiler NuGet for your own projects
• Linux/Mac/Windows ILSpy UI based on Avalonia - check out https://github.com/icsharpcode/AvaloniaILSpy
• Linux/Mac/Windows command line client - check out ICSharpCode.Decompiler.Console in this repository
• Linux/Mac/Windows PowerShell cmdlets in this repository

Features

• Decompilation to C#
• Whole-project decompilation (csproj, not sln!)
• Search for types/methods/properties (substring)
• Hyperlink-based type/method/property navigation
• Base/Derived types navigation, history
• BAML to XAML decompiler
• Extensible via plugins (MEF)
• Check out the language support status

License

ILSpy is distributed under the MIT License.

Included open-source libraries:

• Mono.Cecil: MIT License (part of ILSpy)
• LightJson: MIT License (part of ICSharpCode.Decompiler)
• Humanizer: MIT License (part of ICSharpCode.Decompiler)
• AvalonEdit: MIT License
• SharpTreeView: LGPL
• ILSpy.BamlDecompiler: MIT license
• CommandLineUtils: Apache License 2.0 (part of ICSharpCode.Decompiler.Console)

How to build

Windows:

• Install Visual Studio (minimum version: 2017.7) with the following components:
  • Workload ".NET Desktop Development"
  • .NET Framework 4.6.2 Targeting Pack (if the VS installer does not offer this option, install the .NET 4.6.2 developer pack separately)
  • Individual Component "VC++ 2017 version 15.9 v14.16 latest v141 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.
• Install the .NET Core SDK 2.2
• Check out the ILSpy repository using git.
• Execute git submodule update --init --recursive to download the ILSpy-Tests submodule (used by some test cases).
• 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

Unix:

• Make sure .NET Core 2.2 is installed (you can get it here: https://get.dot.net).
• Check out the repository using git.
• Execute git submodule update --init --recursive to download the ILSpy-Tests submodule (used by some test cases).
• Use dotnet build Frontends.sln to build the non-Windows flavors of ILSpy (cli and powershell core).

(Visual Studio for Mac users only:)

• Edit \ICSharpCode.Decompiler\ICSharpCode.Decompiler.csproj Add Sdk="Microsoft.NET.Sdk" to the Project element. This is required due to a tooling issue. Please do not commit this when contributing a pull request!
• Use Frontends.sln to work.

How to contribute

• Report bugs
• If you want to contribute a pull request, please add https://gist.github.com/siegfriedpammer/75700ea61609eb22714d21885e4eb084 to your .git/hooks to prevent checking in code with wrong indentation. We use tabs and not spaces. The build server runs the same script, so any pull requests using wrong indentation will fail.

Current and past contributors.