dotnet-inspect

CLI tool for inspecting .NET libraries and NuGet packages. It is for .NET what docker inspect and kubectl describe are for container land — view metadata, APIs, vulnerabilities, provenance, and compare versions.

Installation

dotnet tool install -g dotnet-inspect

Or run without installing (like npx):

dnx dotnet-inspect -y -- <command>

Quick Reference

Command	Purpose
package X	Package metadata, dependencies, files, versions
library X	Library metadata, symbols, SourceLink audit, dependency tree
api X	Public API surface (table format, or --shape for hierarchy)
diff X	Compare versions with breaking/additive classification
extensions X	Find extension methods/properties for a type
implements X	Find types implementing an interface or extending a class
find X	Search for types across packages, frameworks, and local assets
samples X	Fetch and display code samples
platform	List installed frameworks
cli	CLI args explorer (tree view)

Bare Names

A bare name like dotnet-inspect System.Text.Json uses a router to pick the best source. Platform libraries (System.*, Microsoft.AspNetCore) resolve to the installed SDK by default. Other names resolve to NuGet packages. Use explicit package or library --package to override.

Common Flags

Flag	Description
-v:q/m/n/d	Verbosity: quiet, minimal (default), normal, detailed
--dotnet	Search runtime + aspnetcore + curated Microsoft packages (find, extensions, implements)
--json	JSON output
-s Name	Include section (glob-capable: -s Ext*)
-x Name	Exclude section
--shape	Type shape diagram (hierarchy + members)
--source-link-audit	SourceLink/determinism audit
-T:q/d	Tips verbosity (contextual hints on stderr)

Commands

package

Inspect NuGet packages. This is the default command for bare names that don't match platform libraries.

dotnet-inspect package System.Text.Json                     # Metadata (latest version)
dotnet-inspect package System.Text.Json@8.0.0 -v:d          # Detailed (shows vulnerabilities)
dotnet-inspect package System.Text.Json --versions          # List available versions
dotnet-inspect package System.Text.Json --version 11.0.0-preview*  # Wildcard version
dotnet-inspect package System.Text.Json --layout --lib      # File tree (lib/ only)
dotnet-inspect package System.Text.Json --dependencies      # Package dependency tree
dotnet-inspect package System.Text.Json --tfms              # List target frameworks

Multi-library packages

Some packages bundle multiple libraries per TFM (e.g., Microsoft.Azure.SignalR).

dotnet-inspect package Microsoft.Azure.SignalR              # Shows Libraries: 2
dotnet-inspect package Microsoft.Azure.SignalR --layout     # File tree
dotnet-inspect api Microsoft.Azure.SignalR -v:q --library Microsoft.Azure.SignalR.Common.dll  # Secondary library

Custom NuGet sources

dotnet-inspect package MyPackage --source https://my-feed/v3/index.json
dotnet-inspect package MyPackage --add-source https://dev-feed/v3/index.json --prerelease
dotnet-inspect package MyPackage --nugetconfig ./nuget.config

library

Inspect a library — from platform, NuGet package, or local file.

dotnet-inspect library System.Text.Json                     # Platform library (runtime)
dotnet-inspect library --package System.Text.Json            # Library from NuGet package
dotnet-inspect library ./bin/MyLib.dll                       # Local file
dotnet-inspect library --package System.Text.Json -s         # List 13 available sections
dotnet-inspect library --package System.Text.Json --source-link-audit  # SourceLink audit
dotnet-inspect library Microsoft.Extensions.AI.OpenAI --dependencies   # Dependency tree (visual)
dotnet-inspect library System.Text.Json --references -s Lib*           # Direct references
dotnet-inspect library --package System.Text.Json --extract-resources resources/  # Extract resources

api

Extract public API surface with positional syntax and fuzzy matching.

dotnet-inspect api System.Text.Json                              # All types in package
dotnet-inspect api System.Text.Json JsonSerializer               # Specific type — member lists
dotnet-inspect api System.Text.Json JsonSerializer Serialize     # Filter to member(s)
dotnet-inspect api System.Text.Json JsonSerializer -m 'Deseri*'  # Glob member filter
dotnet-inspect api 'HashSet<T>' --platform System.Collections --shape  # Type shape diagram
dotnet-inspect api System.Text.Json JsonSerializer --docs        # With XML documentation
dotnet-inspect api System.Text.Json JsonArray -v:d -s:Interfaces # Section filter
dotnet-inspect api --platform System.Text.Json JsonSerializer    # Platform library
dotnet-inspect api System.Text.Json@9.0.0 JsonSerializer        # Specific version
dotnet-inspect api 'Option<T>' --package System.CommandLine      # Generic types (quote!)
dotnet-inspect api Markout MarkoutWriter --samples -v:q          # Code samples

Member selection and decompilation — use --select to see Name:N addressing hints, then drill in:

$ dotnet-inspect api --package Microsoft.Extensions.Options OptionsFactory --select
## Constructors

| Select | Name | Signature |
| ------ | ---- | --------- |
| `.ctor:1` | .ctor | `void .ctor(IEnumerable<IConfigureOptions<TOptions>>, ...)` |
| `.ctor:2` | .ctor | `void .ctor(IEnumerable<IConfigureOptions<TOptions>>, ..., IEnumerable<IValidateOptions<TOptions>>)` |

## Methods

| Select | Name | Signature |
| ------ | ---- | --------- |
| `Create` | Create | `TOptions Create(string)` |

Then target a member using the Name:N shorthand to get source, decompiled C#, and IL:

$ dotnet-inspect api --package Microsoft.Extensions.Options OptionsFactory Create
## Source                          # Original C# (via SourceLink)
## Lowered C#                     # Decompiled C# faithful to IL semantics
## IL                             # Raw IL disassembly with resolved tokens
## IL (Annotated)                 # IL with pre-execution stack state at each instruction

diff

Compare API surfaces between versions. Changes are classified as breaking, additive, or potentially breaking.

dotnet-inspect diff System.CommandLine@2.0.0-beta4.22272.1..2.0.3 -v:q  # Full package diff
dotnet-inspect diff JsonSerializer --package System.Text.Json@9.0.0..10.0.2  # Single type
dotnet-inspect diff "*Writer*" --package Markout@0.1.8..0.2.0            # Glob filter
dotnet-inspect diff --platform System.Text.Json@8.0.23..10.0.2           # Platform versions
dotnet-inspect diff System.Text.Json@9.0.0..10.0.2 --stat               # Stats only
dotnet-inspect diff System.Text.Json@9.0.0..10.0.2 --breaking           # Breaking only

find

Search for types across packages, frameworks, and local assets.

dotnet-inspect find HttpClient                           # Runtime (default scope)
dotnet-inspect find "*Stream*" -n 10                     # Glob, limit results
dotnet-inspect find "*Json*" --package System.Text.Json  # Search in package
dotnet-inspect find "ChatClient*" --dotnet --terse       # Search all .NET scopes
dotnet-inspect find ILogger --framework aspnetcore       # ASP.NET Core framework
dotnet-inspect find "*Command*" --project ./MyApp.csproj # Project dependencies

extensions

Find extension methods and properties for a type. Detects both classic extension methods and C# 14 extension properties.

dotnet-inspect extensions HttpClient                         # Runtime (default)
dotnet-inspect extensions HttpClient --reachable             # Include reachable types
dotnet-inspect extensions DbContext --dotnet                  # Search all .NET scopes
dotnet-inspect extensions IDistributedApplicationBuilder \
  --package Aspire.Hosting --package Aspire.Hosting.Redis    # Multi-package scan

implements

Find types implementing an interface or extending a base class.

dotnet-inspect implements Stream --dotnet                    # Runtime + aspnetcore + packages
dotnet-inspect implements IDisposable --framework runtime
dotnet-inspect implements IJsonTypeInfoResolver --package System.Text.Json

samples

Fetch and display code samples from SourceLink-indexed sources.

dotnet-inspect samples Markout MarkoutWriter --list  # List available samples
dotnet-inspect samples Markout MarkoutWriter         # Print all samples
dotnet-inspect samples Newtonsoft.Json JObject        # Third-party examples

platform

List installed frameworks.

dotnet-inspect platform                             # List frameworks
dotnet-inspect platform --framework runtime         # List runtime libraries
dotnet-inspect platform --list-versions             # Installed SDK versions

cache

dotnet-inspect cache                                # Show cache size breakdown
dotnet-inspect cache --clean                        # Clear the cache

cli

dotnet-inspect cli                                  # Tree view (single level)
dotnet-inspect cli -v:d                             # Deep view (all levels)
dotnet-inspect cli api                              # Specific command with options

Output Control

Verbosity (-v): q(uiet) → m(inimal) → n(ormal) → d(etailed)

Each level includes a compact summary line with key metadata:

Version: 8.0.0 | Type: Library | TFM: net8.0 | Updated: 2023-11-14 | Vulnerabilities: 2

Sections: Use -s Name to include or -x Name to exclude sections by name. Bare -s lists available sections. Supports glob patterns (-s Ext*).

JSON: --json for full JSON, --json --compact for minified.

LLM Integration

This tool is designed for LLM-driven development. Run dotnet-inspect llmstxt for detailed usage patterns.

A skill for use with GitHub Copilot agent mode is available at dotnet-skills.

Requirements

.NET 10.0 SDK or later

License

MIT