OS Manuals

/usr/bin/swift-api-digester

Swift is a high-performance system programming language. It has a clean and modern syntax, offers seamless access to existing C and Objective-C code and frameworks, and is memory-safe by default.

From swift 6.4.2-r0 (enterprise-packages), captured 2026-11-08 by running swift-api-digester --help (exit 1). permalink

Also provided by 2 other package versions
OVERVIEW: Swift API Digester

USAGE: swift-frontend

OPTIONS:
  -abi                   Dumping ABI interface
  -abort-on-module-fail  Abort if a module failed to load
  -avoid-location        Avoid serializing the file paths of SDK nodes.
  -avoid-tool-args       Avoid serializing the arguments for invoking the tool.
  -baseline-dir <value>  The path to a directory containing baseline files: macos.json, iphoneos.json, appletvos.json, watchos.json, and iosmac.json
  -baseline-path <value> The path to the Json file that we should use as the baseline
  -BF <value>            add a directory to the baseline framework search path
  -BI <value>            add a module for baseline input
  -breakage-allowlist-path <value>
                         An allowlist of breakages to not complain about
  -bsdk <value>          path to the baseline SDK to import frameworks
  -clang-target-variant <value>
                         Separately set the target we should use for internal Clang instance for the 'zippered' code for macCatalyst
  -clang-target <value>  Separately set the target we should use for internal Clang instance
  -compiler-style-diags  Print compiler style diagnostics to stderr.
  -debug-mapping         Dumping information for debug purposes
  -deserialize-diff      Deserialize diff items in a JSON file
  -deserialize-sdk       Deserialize sdk digester in a JSON file
  -diagnose-sdk          Diagnose SDK content in JSON file
  -disable-fail-on-error Don't exit with a nonzero status if errors are emitted
  -disable-os-checks     Skip OS related diagnostics
  -disable-remove-deprecated-check
                         Skip diagnosing removal of deprecated symbols
  -dump-sdk              Dump SDK content to JSON file
  -empty-baseline        Use empty baseline for diagnostics
  -enable-remove-deprecated-check
                         Diagnosing removal of deprecated symbols
  -error-on-abi-breakage Always treat ABI checker issues as errors
  -external-plugin-path <path>#<plugin-server-path>
                         Add directory to the plugin search path with a plugin server executable
  -find-usr              Find USR for decls by given condition
  -Fsystem <value>       Add directory to system framework search path
  -F <value>             Add directory to framework search path
  -generate-empty-baseline
                         Generate an empty baseline
  -generate-migration-script
                         Compare SDK content in JSON file and generate migration script
  -generate-name-correction
                         Generate name correction template
  -help                  Display available options
  -ignore-spi-group-new-api <value>
                         Suppress “new API without '@available’ diagnostic for given SPI group name
  -ignore-spi-group <value>
                         SPI group name to not diagnose about
  -ignored-usrs <path>   the file containing USRs of removed decls that the digester should ignore
  -input-paths <path>    The SDK contents under comparison
  -Isystem <value>       Add directory to the system import search path
  -I <value>             Add directory to the import search path
  -json                  Print output in JSON format.
  -language-mode <mode>  Interpret input according to a specific Swift language mode
  -location <location>   Filter nodes with the given location.
  -migrator              Dump Json suitable for generating migration script
  -module-cache-path <value>
                         Specifies the module cache path
  -module-list-file <value>
                         File containing a new-line separated list of modules
  -module <name>         Names of modules
  -output-dir <dir>      Output directory
  -o <file>              Write output to <file>
  -plugin-path <value>   Add directory to the plugin search path
  -print-module          Print module names in diagnostics
  -protocol-requirement-allow-list <path>
                         File containing a new-line separated list of protocol names
  -resource-dir </usr/lib/swift>
                         The directory that holds the compiler resource files
  -sdk <sdk>             Compile against <sdk>
  -serialize-diagnostics-path <path>
                         Emit a serialized diagnostics file to <path>
  -strict-memory-safety:migrate
                         Enable migration to strict memory safety checking
  -strict-memory-safety  Enable strict memory safety checking
  -swift-only            Only include APIs defined from Swift source
  -swift-version <vers>  Interpret input according to a specific Swift language version number
  -sysroot <sysroot>     Native Platform sysroot
  -target <triple>       Generate code for the given target <triple>, such as x86_64-apple-macos10.9
  -use-interface-for-module <name>
                         Prefer loading these modules via interface
  -visualc-tools-root <root>
                         VisualC++ Tools Root
  -visualc-tools-version <version>
                         VisualC++ ToolSet Version
  -v                     Show commands to run and use verbose output
  -windows-sdk-root <root>
                         Windows SDK Root
  -windows-sdk-version <version>
                         Windows SDK Version
  -Xcc <arg>             Pass <arg> to the C/C++/Objective-C compiler
Options (62)
OptionDescriptionSource
-abiDumping ABI interfacehelp
-abort-on-module-failAbort if a module failed to loadhelp
-avoid-locationAvoid serializing the file paths of SDK nodes.help
-avoid-tool-argsAvoid serializing the arguments for invoking the tool.help
-baseline-dir valueThe path to a directory containing baseline files: macos.json, iphoneos.json, appletvos.json, watchos.json, and iosmac.jsonhelp
-BF valueadd a directory to the baseline framework search pathhelp
-BI valueadd a module for baseline inputhelp
-breakage-allowlist-path valueAn allowlist of breakages to not complain abouthelp
-bsdk valuepath to the baseline SDK to import frameworkshelp
-clang-target-variant valueSeparately set the target we should use for internal Clang instance for the 'zippered' code for macCatalysthelp
-clang-target valueSeparately set the target we should use for internal Clang instancehelp
-compiler-style-diagsPrint compiler style diagnostics to stderr.help
-debug-mappingDumping information for debug purposeshelp
-deserialize-diffDeserialize diff items in a JSON filehelp
-deserialize-sdkDeserialize sdk digester in a JSON filehelp
-diagnose-sdkDiagnose SDK content in JSON filehelp
-disable-os-checksSkip OS related diagnosticshelp
-disable-remove-deprecated-checkSkip diagnosing removal of deprecated symbolshelp
-dump-sdkDump SDK content to JSON filehelp
-empty-baselineUse empty baseline for diagnosticshelp
-enable-remove-deprecated-checkDiagnosing removal of deprecated symbolshelp
-external-plugin-path path>#<plugin-server-pathAdd directory to the plugin search path with a plugin server executablehelp
-find-usrFind USR for decls by given conditionhelp
-Fsystem valueAdd directory to system framework search pathhelp
-F valueAdd directory to framework search pathhelp
-generate-empty-baselineGenerate an empty baselinehelp
-generate-migration-scriptCompare SDK content in JSON file and generate migration scripthelp
-generate-name-correctionGenerate name correction templatehelp
-helpDisplay available optionshelp
-ignore-spi-group-new-api valueSuppress “new API without '@available’ diagnostic for given SPI group namehelp
-ignore-spi-group valueSPI group name to not diagnose abouthelp
-ignored-usrs paththe file containing USRs of removed decls that the digester should ignorehelp
-input-paths pathThe SDK contents under comparisonhelp
-Isystem valueAdd directory to the system import search pathhelp
-I valueAdd directory to the import search pathhelp
-jsonPrint output in JSON format.help
-language-mode modeInterpret input according to a specific Swift language modehelp
-location locationFilter nodes with the given location.help
-migratorDump Json suitable for generating migration scripthelp
-module-cache-path valueSpecifies the module cache pathhelp
-module-list-file valueFile containing a new-line separated list of moduleshelp
-module nameNames of moduleshelp
-output-dir dirOutput directoryhelp
-o fileWrite output to <file>help
-plugin-path valueAdd directory to the plugin search pathhelp
-print-modulePrint module names in diagnosticshelp
-protocol-requirement-allow-list pathFile containing a new-line separated list of protocol nameshelp
-resource-dir /usr/lib/swiftThe directory that holds the compiler resource fileshelp
-sdk sdkCompile against <sdk>help
-serialize-diagnostics-path pathEmit a serialized diagnostics file to <path>help
-strict-memory-safetyEnable strict memory safety checkinghelp
-swift-onlyOnly include APIs defined from Swift sourcehelp
-swift-version versInterpret input according to a specific Swift language version numberhelp
-sysroot sysrootNative Platform sysroothelp
-target tripleGenerate code for the given target <triple>, such as x86_64-apple-macos10.9help
-use-interface-for-module namePrefer loading these modules via interfacehelp
-visualc-tools-root rootVisualC++ Tools Roothelp
-visualc-tools-version versionVisualC++ ToolSet Versionhelp
-vShow commands to run and use verbose outputhelp
-windows-sdk-root rootWindows SDK Roothelp
-windows-sdk-version versionWindows SDK Versionhelp
-Xcc argPass <arg> to the C/C++/Objective-C compilerhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.