- Dev Build
- Native Image
- Build Output
- Build Configuration
- Tracing Agent
- Experimental Agent Options
- Native Image Compatibility and Optimization Guide
- Class Initialization in Native Image
- Static Native Images
- Native Image Options
- Native Image Hosted and Runtime Options
- Native Image Inspection Tool
- Native Image C API
- Implementing Native Methods in Java with Native Image
- LLVM Backend for Native Image
- Debug Info Feature
- Points-to Analysis Reports
- Using System Properties in Native Image
- Profile-Guided Optimizations
- Memory Management at Image Run Time
- Generating Heap Dumps from Native Images
- JDK Flight Recorder with Native Image
- JCA Security Services on Native Image
- Dynamic Proxy on Native Image
- Java Native Interface (JNI) on Native Image
- Reflection on Native Image
- Accessing Resources in Native Images
- Logging on Native Image
- URL Protocols on Native Image
- Native Image ARM64 Support
- GraalVM Updater
- Languages References
- Embedding Reference
- Polyglot Programming
Native Image Options
To ahead-of-time compile your Java application into a native executable, provide the classpath for all classes using the
-cp option followed by a list of directories or JAR files, separated by
: to the
The name of the class containing the
main method should be the last argument, or you can use
-jar and provide a JAR file that specifies the
main method in its manifest.
The syntax of the
native-image command is:
native-image [options] class [imagename] [options]to build a native executable for a class in the current working directory. Invoking it executes the native-compiled code of that class.
native-image [options] -jar jarfile [imagename] [options]to build a native executable for a JAR file.
native-image [options] --module <module>[/<mainclass>] [options]to build a native executable for a module.
--moduleis equivalent to
The options passed to
native-image are evaluated left-to-right.
For more information, see Native Image Build Configuration.
The options fall into several categories: standard, non-standard and macro options. Non-standard options are subject to change through a deprecation cycle.
Command-line help is available.
native-image --help to get the commands overview, and
native-image --help-extra to print help on non-standard and macro options.
Options to Native Image Builder #
native-image --help to get the options overview.
Depending on the GraalVM edition, the commands to the
native-image builder may differ.
@argument files: pass one or more argument files containing options
-cp, -classpath, --class-path <class search path of directories and zip/jar files>: a
:separated list of directories, JAR archives, and ZIP archives to search for class files
-p <module path>, --module-path <module path>: a
:separated list of directories; each directory is a directory of modules
--add-modules <module name>[,<module name>...]: add root modules to resolve in addition to the initial module.
<module name>can also be
-D<name>=<value>: set a system property
<flag>directly to the JVM running the
-O<level>: 0 for no optimizations, or 1 for basic optimizations (default)
--verbose: enable verbose output
--version: print the product version and exit
--help: print this help message
--help-extra: print help on non-standard options
--auto-fallback: build a standalone native executable if possible
--configure-reflection-metadata: enable runtime instantiation of reflection objects for non-invoked methods
--enable-all-security-services: add all security service classes to a native executable
--enable-http: enable HTTP support in a native executable
--enable-https: enable HTTPS support in a native executable
--enable-url-protocols: list comma-separated URL protocols to enable
--features: a comma-separated list of fully qualified Feature implementation classes
--force-fallback: force building of a fallback native executable
--gc=<value>: select Native Image garbage collector implementation. Allowed options for
G1for G1 garbage collector (GraalVM Enterprise only);
epsilonfor Epsilon garbage collector;
serialfor Serial garbage collector (default).
--initialize-at-build-time: a comma-separated list of packages and classes (and implicitly all of their superclasses) that are initialized during image generation. An empty string designates all packages.
--initialize-at-run-time: a comma-separated list of packages and classes (and implicitly all of their subclasses) that must be initialized at run time and not during image building. An empty string is currently not supported.
--libc: select the
libcnative library implementation to use. Available implementations are
--link-at-build-time: require types to be fully defined at native executable build time. If used without arguments, all classes in scope of the option are required to be fully defined.
--link-at-build-time-paths: require all types in given class or module-path entries to be fully defined at native executable build time
--list-cpu-features: show CPU features specific to the target platform and exit
--native-compiler-options: provide a custom C compiler option used to query code compilation
--native-compiler-path: provide a custom path to the C compiler used to query code compilation and linking
--native-image-info: show native toolchain information and native executable’s build settings
--no-fallback: build a standalone native executable or report a failure
--pgo: a comma-separated list of files from which to read the data collected for profile-guided optimization of AOT compiled code (reads from default.iprof if nothing is specified). GraalVM Enterprise only
--pgo-instrument: instrument AOT compiled code to collect data for profile-guided optimization into the default.iprof file. GraalVM Enterprise only
--report-unsupported-elements-at-runtime: report the usage of unsupported methods and fields at run time when they are accessed the first time, instead of an error during building a native executable
--shared: build a shared library
--static: build a statically-linked native executable (requires
--target: select the native image compilation target (in
- format). It defaults to the host's OS-architecture pair
--trace-class-initialization: provide a comma-separated list of fully-qualified class names that a class initialization is traced for
--trace-object-instantiation: provide a comma-separated list of fully-qualified class names that an object instantiation is traced for
-da: disable assertions with specified granularity in the generated native executable. The
disableassertions[:[packagename]|:[classname]variants are also supported.
-dsa: disable assertions in all system classes
-ea: enable assertions with specified granularity in a generated native executable. The
enableassertions[:[packagename]|:[classname]variants are also supported.
-esa: enable assertions in all system classes
-g: generate debugging information. The debug information produced on GraalVM Community will differ from that generated on GraalVM Enterprise.
Macro Options #
--language:nfi: make the Truffle Native Function Interface language available
--language:python: make Python available as a language for the executable
--language:R: make R available as a language for the executable
--language:regex: make the Truffle Regular Expression engine available
--language:wasm: make WebAssembly available as a language for the executable
--language:java: make Java available as a language for the executable
--language:llvm: make LLVM bitcode available as a language for the executable
--language:nodejs: make Node.js available for the executable
--language:ruby: make Ruby available as a language for the executable
--tool:coverage: add source code coverage support to a GraalVM supported language
--tool:insight: add support for detailed access to a program’s runtime behavior, allowing users to inspect values and types at invocation or allocation sites
--tool:dap: add support to allow image to open a debugger port serving the Debug Adapter Protocol in IDEs like VS Code
--tool:chromeinspector: add debugging support to a GraalVM supported language
--tool:insightheap: snapshot a region of image heap during the execution
--tool:lsp: add the Language Server Protocol support to later attach compatible debuggers to GraalVM in IDEs like VS Code
--tool:sandbox: enables the Truffle sandbox resource limits. For more information, check the dedicated documentation
--tool:profiler: add profiling support to a GraalVM supported language
--language:llvm polyglot macro options become available once the corresponding languages are added to the base GraalVM installation (see the GraalVM Updater guide).
Non-standard Options #
native-image --help-extra for non-standard options help.
--expert-options: list image build options for experts
--expert-options-all: list all image build options for experts (use at your own risk). Options marked with [Extra help available] contain help that can be shown with
--expert-options-detail: display all available help for a comma-separated list of option names. Pass
*to show extra help for all options that contain it
--configurations-path <search path of option-configuration directories>: a separated list of directories to be treated as option-configuration directories
--debug-attach[=< port >]: attach to debugger during image building (default port is 8000)
--diagnostics-mode: enable logging of the build information to a diagnostics folder
--dry-run: output the command line that would be used for building a native executable
-V<key>=<value>: provide values for placeholders in native-image.properties files
<target-module>, regardless of module declaration.
ALL-UNNAMEDto export to all unnamed modules
<target-module>, regardless of module declaration
<target-module>, regardless of module declaration.
ALL-UNNAMEDto read all unnamed modules
Native Image options are also distinguished as hosted and runtime options. Continue reading to the Native Image Hosted and Runtime Options guide.