OS Manuals

/usr/bin/swift-ide-test

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-bootstrap-5-10-1 5.10.1-r7 (enterprise-packages), captured 2026-11-08 by running swift-ide-test --help (exit 0). permalink

OVERVIEW: Swift IDE Test

USAGE: swift-ide-test [options] [input files...]

OPTIONS:

Generic Options:

  --help                                         - Display available options (--help-hidden for more)
  --help-list                                    - Display list of available options (--help-list-hidden for more)
  --version                                      - Display the version of this program

swift-ide-test Options:

  -D <string>                                    - Conditional compilation flags
  -F <string>                                    - add a directory to the framework search path
  -I <string>                                    - add a directory to the import search path
  --Xcc=<string>                                 - option to pass to clang
  --abstract-accessors                           - Hide the concrete accessors used to implement a property or subscript
  Access filter:
      --access-filter-private                       - Print all declarations
      --access-filter-internal                      - Print internal and public declarations
      --access-filter-public                        - Print public declarations
  --access-notes-path=<string>                   - Path to access notes file
  --always-argument-labels                       - Whether to always print separate argument labels
  --annotate-print                               - Annotate AST printing
  --code-complete-add-call-with-no-default-args  - Whether to include a function completion that contains no default arguments
  --code-complete-call-pattern-heuristics        - Use heuristics to guess whether we want call pattern completions
  --code-complete-inits-in-postfix-expr          - Include initializers when completing a postfix expression
  --code-completion-annotate-results             - annotate completion results with XML
  --code-completion-comments                     - Include comments in code completion results
  --code-completion-diagnostics                  - Print compiler diagnostics while doing code completion
  --code-completion-keywords                     - Include keywords in code completion results
  --code-completion-sourcetext                   - Include source texts in code completion results
  --code-completion-token=<string>               - Code completion token name
  --comments-xml-schema=<string>                 - Filename of the RelaxNG schema for documentation comments
  --completion-cache-path=<string>               - Code completion cache path
  --completion-output-dir=<path>                 - Directory for completion output
  --conforming-methods-expected-types=<string>   - Set expected types for comforming method list
  --cxx-interop-getters-setters-as-properties    - Imports getters and setters as computed properties.
  --debug-client-discriminator=<string>          - A discriminator to prefer in lookups
  --debug-constraints                            - Enable verbose debugging from the constraint solver.
  --debug-forbid-typecheck-prefix=<string>       - Triggers llvm fatal_error if typechecker tries to typecheck a decl with the provided prefix name
  --decl-to-print=<string>                       - Decl name to print swift interface for
  --define-availability=<string>                 - Define a macro for @available
  --disable-access-control                       - Disables access control, like a debugger
  --disable-objc-attr-requires-foundation-module - Allow @objc to be used freely
  --disable-objc-interop                         - Disable ObjC interop.
  --enable-cross-import-overlays                 - Automatically import declared cross-import overlays.
  --enable-deserialization-safety                - Avoid reading potentially unsafe decls from swiftmodules
  --enable-experimental-cxx-interop              - Enable C++ interop.
  --enable-experimental-feature=<string>         - Enable an experimental feature
  --enable-objc-forward-declarations             - Import Objective-C forward declarations when possible
  --enable-objc-interop                          - Enable ObjC interop.
  --enable-swift3-objc-inference                 - Enable Swift 3's @objc inference rules
  --enable-swiftsourceinfo                       - Whether to consume .swiftsourceinfo files
  --end-pos=<string>                             - Line:Column pair
  --explicit-swift-module-map-file=<string>      - JSON file to include explicit Swift modules
  --explode-pattern-binding-decls                - Separate pattern binding decls into individual var decls
  --expressions                                  - Print expressions
  --filecheck=<path>                             - Path to 'FileCheck' utility
  --find-mangled=<string>                        - Print the entity with the given mangled name
  --fully-qualified-types                        - Print fully qualified types
  --fully-qualified-types-if-ambiguous           - Print types fully-qualified if they would be ambiguous otherwise
  --function-definitions                         - Print function bodies
  --header-to-print=<string>                     - Header filename to print swift interface for
  --iframework=<string>                          - add a directory to the system framework search path
  --import-objc-header=<string>                  - header to implicitly import
  --include-locals                               - Index local symbols too.
  --load-plugin-executable=<string>              - load plugin executable
  --load-plugin-library=<string>                 - load plugin library
  --module-alias=<string>                        - Use '-module-alias <name>=<binary_name>' to map a module of <name> that appears in source code to <binary_name>
  --module-cache-path=<string>                   - Clang module cache path
  --module-group=<string>                        - Name of the module group to print
  --module-name=<string>                         - The module name of the given test.
  --module-print-hidden                          - Print non-exported imported or submodules
  --module-print-skip-overlay                    - Skip Swift overlay modules
  --module-print-submodules                      - Recursively print submodules
  --module-to-print=<string>                     - Name of the module to print
  --no-empty-line-between-members                - Print no empty line between members.
  --parse-as-library                             - Parse '-source-filename' as a library source file
  --pch-output-dir=<string>                      - place autogenerated PCH files in this directory
  --playground                                   - Whether coloring in playground
  --plugin-path=<string>                         - plugin-path
  --pos=<string>                                 - Line:Column pair
  --prefer-type-repr                             - When printing types, prefer printing TypeReprs
  --print-access                                 - Print access keywords for all values
  Mode:
      --batch-code-completion                       - Perform code completion in batch mode
      --code-completion                             - Perform code completion
      --repl-code-completion                        - Perform REPL-style code completion
      --dump-completion-cache                       - Dump a code completion cache file
      --dump-importer-lookup-table                  - Dump the Clang importer's lookup tables
      --syntax-coloring                             - Perform syntax coloring
      --dump-comments                               - Dump documentation comments attached to decls
      --structure                                   - Perform document structure annotation
      --annotate                                    - Perform semantic annotation
      --test-input-complete                         - Check if input source is complete
      --print-ast-not-typechecked                   - Print the non-typechecked AST
      --print-ast-typechecked                       - Print the typechecked AST
      --print-module                                - Print visible declarations in a module
      --print-module-metadata                       - Print meta-data in a module
      --print-header                                - Print visible declarations in a header file
      --print-swift-file-interface                  - Print interface of a swift file
      --print-decl                                  - Print interface of a decl
      --print-types                                 - Print types of all subexpressions and declarations in the AST
      --print-comments                              - Print documentation comments attached to decls
      --print-module-comments                       - Given a module, print documentation comments attached to decls
      --print-module-imports                        - Recursively print all imports visible from a particular module
      --print-usrs                                  - Print USRs for all decls
      --print-local-types                           - Print local types and remanglings in a module
      --test-createCompilerInvocation               - Test swift::driver::createCompilerInvocation using the arguments passed to swift-ide-test (must be specified before all other arguments)
      --test-CompilerInvocation-from-module         - Test CompilerInvocation::loadFromSerializedAST on the "source" file
      --generate-module-api-description             - Generate a machine-readable description of module API
      --diff-module-api                             - Compare machine-readable descriptions of module API
      --print-type-interface                        - Print type-specific interface decl
      --reconstruct-type                            - Reconstruct type from mangled name
      --print-module-groups                         - Print group names in a module
      --range                                       - Print information about a given range
      --print-indexed-symbols                       - Print indexed symbol information
      --type-context-info                           - Perform expression context info analysis
      --print-expr-type                             - Print types for all expressions in the file
      --conforming-methods                          - Perform conforming method analysis for expression
  --print-implicit-attrs                         - Print implicit attributes
  --print-interface                              - Print with options set for interface printing, overrides any other printing option
  --print-interface-doc                          - Print with options set for interface printing, for doc support; overrides any other printing option
  --print-original-source                        - print the original source text for applicable declarations
  --print-regular-comments                       - Print regular comments from clang module headers
  --print-stats                                  - Print statistics
  --random-seed=<seed>                           - Seed for the random number generator
  --resource-dir=<string>                        - The directory that holds the compiler resource files
  --sdk=<string>                                 - path to the SDK to build against
  --second-source-filename=<string>              - Name of the second source file
  --serialized-path-obfuscate=<string>           - Path to access notes file
  --skip-deinit                                  - Whether to skip printing destructors
  --skip-filecheck                               - Skip 'FileCheck' checking
  --skip-imports                                 - Whether to skip printing import declarations
  --skip-overrides                               - Whether to skip printing overrides/witnesses
  --skip-parameter-names                         - Whether to skip parameter names
  --skip-print-doc-comments                      - Don't print documentation comments from clang module headers
  --skip-private-stdlib-decls                    - Don't print declarations that start with '_'
  --skip-unavailable                             - Don't print unavailable declarations
  --skip-underscored-stdlib-protocols            - Don't print protocols that start with '_'
  --skip-unsafe-cxx-methods                      - Don't print unsafe C++ class methods that were renamed as unsafe
  --source-filename=<string>                     - Name of the source file
  --swift-version=<string>                       - Swift version
  --synthesize-extension                         - Print synthesized extensions from conforming protocols.
  --synthesize-sugar-on-types                    - Always print Array and Optional with sugar
  --target=<string>                              - target triple
  --terminal                                     - Use terminal color for source annotations
  --tools-directory=<string>                     - Path to external executables (ld, clang, binutils)
  --typecheck                                    - Type check the AST
  --usr=<string>                                 - USR
  --usr-filter=<string>                          - Filter results by the given usrs
Options (140)
OptionDescriptionSource
--help- Display available options (--help-hidden for more)help
--help-list- Display list of available options (--help-list-hidden for more)help
--version- Display the version of this programhelp
-D string- Conditional compilation flagshelp
-F string- add a directory to the framework search pathhelp
-I string- add a directory to the import search pathhelp
--Xcc string- option to pass to clanghelp
--abstract-accessors- Hide the concrete accessors used to implement a property or subscripthelp
--access-filter-private- Print all declarationshelp
--access-filter-internal- Print internal and public declarationshelp
--access-filter-public- Print public declarationshelp
--access-notes-path string- Path to access notes filehelp
--always-argument-labels- Whether to always print separate argument labelshelp
--annotate-print- Annotate AST printinghelp
--code-complete-add-call-with-no-default-args- Whether to include a function completion that contains no default argumentshelp
--code-complete-call-pattern-heuristics- Use heuristics to guess whether we want call pattern completionshelp
--code-complete-inits-in-postfix-expr- Include initializers when completing a postfix expressionhelp
--code-completion-annotate-results- annotate completion results with XMLhelp
--code-completion-comments- Include comments in code completion resultshelp
--code-completion-diagnostics- Print compiler diagnostics while doing code completionhelp
--code-completion-keywords- Include keywords in code completion resultshelp
--code-completion-sourcetext- Include source texts in code completion resultshelp
--code-completion-token string- Code completion token namehelp
--comments-xml-schema string- Filename of the RelaxNG schema for documentation commentshelp
--completion-cache-path string- Code completion cache pathhelp
--completion-output-dir path- Directory for completion outputhelp
--conforming-methods-expected-types string- Set expected types for comforming method listhelp
--cxx-interop-getters-setters-as-properties- Imports getters and setters as computed properties.help
--debug-client-discriminator string- A discriminator to prefer in lookupshelp
--debug-constraints- Enable verbose debugging from the constraint solver.help
--debug-forbid-typecheck-prefix string- Triggers llvm fatal_error if typechecker tries to typecheck a decl with the provided prefix namehelp
--decl-to-print string- Decl name to print swift interface forhelp
--define-availability string- Define a macro for @availablehelp
--disable-access-control- Disables access control, like a debuggerhelp
--disable-objc-interop- Disable ObjC interop.help
--enable-cross-import-overlays- Automatically import declared cross-import overlays.help
--enable-deserialization-safety- Avoid reading potentially unsafe decls from swiftmoduleshelp
--enable-experimental-cxx-interop- Enable C++ interop.help
--enable-experimental-feature string- Enable an experimental featurehelp
--enable-objc-forward-declarations- Import Objective-C forward declarations when possiblehelp
--enable-objc-interop- Enable ObjC interop.help
--enable-swift3-objc-inference- Enable Swift 3's @objc inference ruleshelp
--enable-swiftsourceinfo- Whether to consume .swiftsourceinfo fileshelp
--end-pos string- Line:Column pairhelp
--explicit-swift-module-map-file string- JSON file to include explicit Swift moduleshelp
--explode-pattern-binding-decls- Separate pattern binding decls into individual var declshelp
--expressions- Print expressionshelp
--filecheck path- Path to 'FileCheck' utilityhelp
--find-mangled string- Print the entity with the given mangled namehelp
--fully-qualified-types- Print fully qualified typeshelp
--fully-qualified-types-if-ambiguous- Print types fully-qualified if they would be ambiguous otherwisehelp
--function-definitions- Print function bodieshelp
--header-to-print string- Header filename to print swift interface forhelp
--iframework string- add a directory to the system framework search pathhelp
--import-objc-header string- header to implicitly importhelp
--include-locals- Index local symbols too.help
--load-plugin-executable string- load plugin executablehelp
--load-plugin-library string- load plugin libraryhelp
--module-alias string- Use '-module-alias <name>=<binary_name>' to map a module of <name> that appears in source code to <binary_name>help
--module-cache-path string- Clang module cache pathhelp
--module-group string- Name of the module group to printhelp
--module-name string- The module name of the given test.help
--module-print-hidden- Print non-exported imported or submoduleshelp
--module-print-skip-overlay- Skip Swift overlay moduleshelp
--module-print-submodules- Recursively print submoduleshelp
--module-to-print string- Name of the module to printhelp
--no-empty-line-between-members- Print no empty line between members.help
--parse-as-library- Parse '-source-filename' as a library source filehelp
--pch-output-dir string- place autogenerated PCH files in this directoryhelp
--playground- Whether coloring in playgroundhelp
--plugin-path string- plugin-pathhelp
--pos string- Line:Column pairhelp
--prefer-type-repr- When printing types, prefer printing TypeReprshelp
--print-access- Print access keywords for all valueshelp
--batch-code-completion- Perform code completion in batch modehelp
--code-completion- Perform code completionhelp
--repl-code-completion- Perform REPL-style code completionhelp
--dump-completion-cache- Dump a code completion cache filehelp
--dump-importer-lookup-table- Dump the Clang importer's lookup tableshelp
--syntax-coloring- Perform syntax coloringhelp
--dump-comments- Dump documentation comments attached to declshelp
--structure- Perform document structure annotationhelp
--annotate- Perform semantic annotationhelp
--test-input-complete- Check if input source is completehelp
--print-ast-not-typechecked- Print the non-typechecked ASThelp
--print-ast-typechecked- Print the typechecked ASThelp
--print-module- Print visible declarations in a modulehelp
--print-module-metadata- Print meta-data in a modulehelp
--print-header- Print visible declarations in a header filehelp
--print-swift-file-interface- Print interface of a swift filehelp
--print-decl- Print interface of a declhelp
--print-types- Print types of all subexpressions and declarations in the ASThelp
--print-comments- Print documentation comments attached to declshelp
--print-module-comments- Given a module, print documentation comments attached to declshelp
--print-module-imports- Recursively print all imports visible from a particular modulehelp
--print-usrs- Print USRs for all declshelp
--print-local-types- Print local types and remanglings in a modulehelp
--test-createCompilerInvocation- Test swift::driver::createCompilerInvocation using the arguments passed to swift-ide-test (must be specified before all other arguments)help
--test-CompilerInvocation-from-module- Test CompilerInvocation::loadFromSerializedAST on the "source" filehelp
--generate-module-api-description- Generate a machine-readable description of module APIhelp
--diff-module-api- Compare machine-readable descriptions of module APIhelp
--print-type-interface- Print type-specific interface declhelp
--reconstruct-type- Reconstruct type from mangled namehelp
--print-module-groups- Print group names in a modulehelp
--range- Print information about a given rangehelp
--print-indexed-symbols- Print indexed symbol informationhelp
--type-context-info- Perform expression context info analysishelp
--print-expr-type- Print types for all expressions in the filehelp
--conforming-methods- Perform conforming method analysis for expressionhelp
--print-implicit-attrs- Print implicit attributeshelp
--print-interface- Print with options set for interface printing, overrides any other printing optionhelp
--print-interface-doc- Print with options set for interface printing, for doc support;help
--print-original-source- print the original source text for applicable declarationshelp
--print-regular-comments- Print regular comments from clang module headershelp
--print-stats- Print statisticshelp
--random-seed seed- Seed for the random number generatorhelp
--resource-dir string- The directory that holds the compiler resource fileshelp
--sdk string- path to the SDK to build againsthelp
--second-source-filename string- Name of the second source filehelp
--serialized-path-obfuscate string- Path to access notes filehelp
--skip-deinit- Whether to skip printing destructorshelp
--skip-filecheck- Skip 'FileCheck' checkinghelp
--skip-imports- Whether to skip printing import declarationshelp
--skip-overrides- Whether to skip printing overrides/witnesseshelp
--skip-parameter-names- Whether to skip parameter nameshelp
--skip-print-doc-comments- Don't print documentation comments from clang module headershelp
--skip-private-stdlib-decls- Don't print declarations that start with '_'help
--skip-unavailable- Don't print unavailable declarationshelp
--skip-underscored-stdlib-protocols- Don't print protocols that start with '_'help
--skip-unsafe-cxx-methods- Don't print unsafe C++ class methods that were renamed as unsafehelp
--source-filename string- Name of the source filehelp
--swift-version string- Swift versionhelp
--synthesize-extension- Print synthesized extensions from conforming protocols.help
--synthesize-sugar-on-types- Always print Array and Optional with sugarhelp
--target string- target triplehelp
--terminal- Use terminal color for source annotationshelp
--tools-directory string- Path to external executables (ld, clang, binutils)help
--typecheck- Type check the ASThelp
--usr string- USRhelp
--usr-filter string- Filter results by the given usrshelp

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