Meziantou.Framework.PublicApiGenerator.Tool 2.0.27

Meziantou.Framework.PublicApiGenerator.Tool

Meziantou.Framework.PublicApiGenerator.Tool is a CLI tool that reads a .NET .dll or .exe and generates compilable C# files describing its public API.

Install

dotnet tool install --global Meziantou.Framework.PublicApiGenerator.Tool

Example

Meziantou.Framework.PublicApiGenerator.Tool \
  --input ./bin/Release/net10.0/MyLibrary.dll \
  --output ./public-api \
  --file-layout OneFilePerNamespace \
  --omit-auto-generated-comment

Multi-target example:

Meziantou.Framework.PublicApiGenerator.Tool \
  --input netstandard2.0=./bin/Release/netstandard2.0/MyLibrary.dll \
  --input net10.0=./bin/Release/net10.0/MyLibrary.dll \
  --output ./public-api \
  --omit-auto-generated-comment

When using multiple --input values, you can use tfm=path to set the target framework explicitly, or use plain paths and let the tool infer target frameworks from assembly metadata (TargetFrameworkAttribute).

--output is the output directory option.

When using --file-layout SingleFile, you can use --output-file to set an explicit file path instead of generating <AssemblyName>.cs in the output directory.

Meziantou.Framework.PublicApiGenerator.Tool \
  --input ./bin/Release/net10.0/MyLibrary.dll \
  --output-file ./public-api/MyLibrary.PublicApi.cs \
  --file-layout SingleFile

Use --verify-no-change to check that generated files are up to date without writing any file. This is useful in CI:

Meziantou.Framework.PublicApiGenerator.Tool \
  --input ./bin/Release/net10.0/MyLibrary.dll \
  --output-file ./public-api/MyLibrary.PublicApi.cs \
  --file-layout SingleFile \
  --verify-no-change

Example output

public-api/
  Demo.g.cs
  GlobalNamespace.g.cs

Help

Description:
  Generate public API stubs from a .NET assembly.

Usage:
  Meziantou.Framework.PublicApiGenerator.Tool [options]

Options:
  --input <input> (REQUIRED)                                     Assembly input. Use either 'path' or 'tfm=path'. Repeat for multi-target generation.
  --output <output>                                              Output directory
  --output-file <output-file>                                    Output file path when --file-layout is SingleFile
  --file-layout <OneFilePerNamespace|OneFilePerType|SingleFile>  File layout: SingleFile, OneFilePerNamespace, or OneFilePerType [default: SingleFile]
  --omit-auto-generated-comment                                  Omit the // <auto-generated/> comment from generated files
  --include-assembly-references                                  List the names of the referenced assemblies in the header of generated files. With a .deps.json file, the assemblies of the framework are not listed
  --include-assembly-reference <include-assembly-reference>      Pattern of the names of the framework assemblies to list with --include-assembly-references ('*' and '?' wildcards). Repeat for several patterns.
  --exclude-assembly-reference <exclude-assembly-reference>      Pattern of the names of the assemblies not to list with --include-assembly-references ('*' and '?' wildcards). Repeat for several patterns.
  --include-all-attributes                                       Write the attributes that are not written by default: EditorBrowsable, the attributes of other namespaces than System, and the assembly attributes
  --delete-unexpected-files                                      Delete the files of the --output directory that are not generated, such as the files of removed types. Only use it when the directory only contains the generated files
  --verify-no-change                                             Verify generated files are up to date without writing changes
  -?, -h, --help                                                 Show help and usage information
  --version                                                      Show version information