Elide bundles Kotlin 2.5.0-Beta2. A runtime-only distribution reports that kotlinc needs the full distribution.
Compile source files
// Hello.kt
fun main() = println("Hello!")
elide kotlinc -- -d out Hello.kt
elide java -- -cp out HelloKt
~/demo elide kotlinc -- -d out Greeter.kt
✅ 1 Kotlin sources compiled to `out` (301ms)
~/demo elide java -- -cp out GreeterKt
Hello, Ada!
Hello, Linus!
kotlinc options go after --; Elide options go before it. elide kotlinc --help lists Elide’s,
elide kotlinc -- -help lists kotlinc’s.
elide java does not add the Kotlin standard library, so code that calls it (listOf, joinToString) fails there:
fun main() = println(listOf("Hello", "Kotlin").joinToString(" "))
| Command | Result |
|---|---|
elide kotlinc -- -d out Hello. then elide java -- -cp out HelloKt | NoClassDefFoundError: kotlin/ |
elide kotlinc -- -include-runtime -d hello. | Compilation fails |
elide run Hello.kt | Hello Kotlin |
elide build with a Jvm.JvmApplication artifact | Start script with the standard library in lib/ |
Elide options
| Option | Purpose |
|---|---|
--incremental | Keep incremental state in ., keyed by output path. |
--incremental-cache-dir DIR | Store incremental state in DIR. |
--plugins LIST | Enable exactly these built-in plugins: metro, serialization, atomicfu, power-assert, compose. |
--metro, --no-metro | Force the Metro DI plugin on or off. |
--compose, --no-compose | Force the opt-in Compose compiler plugin on or off; requires a Compose runtime dependency when enabled. |
--tests | Enable the test plugins (power-assert). |
--max-errors N | Errors shown; 0 shows all. Warnings are de-duplicated and never limited. |
--report-used-deps PATH | Write the classpath entries the compiler read, supertypes included (Bazel strict deps). |
--jdeps PATH | Write a Bazel .jdeps proto: each classpath entry explicit, implicit or unused, with the classes used from it and their SHA-256 hashes. |
--target-label LABEL | Target label recorded in the --jdeps proto. |
--persistent_worker | Run as a Bazel persistent worker, singleplex or multiplex. |
--abi-only | Write only an ABI jar to -d, skipping code generation for non-inline bodies. |
--unused-inputs PATH | Write the classpath entries the compile neither used nor searched (Bazel unused_inputs_list). |
--toolchain-home DIR | Run the compiler from an absolute Kotlin distribution directory, instead of the embedded compiler. |
--toolchain-classpath PATHS | Run a managed compiler with its exact absolute jar classpath, separated by the platform path separator. Mutually exclusive with --toolchain-home. |
--report-abi PATH | Atomically publish the selected compiler’s complete opaque classpath snapshot after successful compilation. The path must be absolute. |
With the bundled compiler, --incremental can be combined with --emit-abi to publish a complete header on every
successful request, including requests with no implementation changes. Header generation performs a complete pass;
retain the implementation output directory together with its incremental cache. Pass the complete source list on
each request. A failed header compile leaves the previous header unchanged.
Selected-toolchain workers
Persistent-worker requests select their compiler before --, using either --toolchain-home or
--toolchain-classpath. The worker keeps one isolated JVM per selection; it never adds Elide’s embedded
compiler or plugin jars to that JVM. Compiler arguments and version-matched -Xplugin paths follow --.
A missing or incompatible selected compiler fails the request rather than falling back to the embedded compiler.
Managed classpaths must include the compiler’s runtime dependencies; source/runtime dependencies still belong
in the compiler’s -classpath. The worker uses the distribution’s JDK to source-launch its compiler adapter.
Selected Kotlin 2.2.21 workers use that compiler’s FIR incremental runner and classpath snapshots.
--incremental requires a directory output, not a jar. In persistent incremental requests,
--transactional-incremental preserves healthy compiler caches and class files after a source error when
the compiler confirms rollback; --warm-incremental runs two additional source-change rounds to warm the
incremental path. ABI reports are compiler-version-specific opaque bytes, not ABI jars, and failed compiles
leave the previous report unchanged.
For kapt, submit plain requests without --incremental: first aptMode=stubs, then, if processing is needed,
aptMode=apt. Keep the same handwritten Kotlin and Java snapshot arguments and private stubs directory
for both requests. Kapt’s apt-only mode skips Kotlin analysis and collects the saved stubs itself; replacing
the compiler arguments with the stub files drops handwritten Java inputs. Keep generated sources and
classes directories private too, and compile generated sources separately after successful processing.
ABI jars
elide kotlinc --abi-only -- -d header.jar src/**/*.kt
elide kotlinc -- -d app.jar --emit-abi header.jar src/**/*.kt
The jar holds public and protected signatures, @Metadata, ABI-relevant inline bodies, const values and
default-argument markers, including declarations that compiler plugins generate, such as kotlinx.serialization’s
$serializer. The ABI output is a compile-time input; run programs against the full implementation classes and
runtime dependencies.
--abi-only writes only the ABI jar. Body stripping is enabled by default: the compiler still analyzes the sources,
but skips most lowering and code generation for non-inline bodies. It retains bodies needed by consumers, including
inline functions. This mode does not replace a full compile when validating a release.
--emit-abi PATH, after --, writes a header alongside a full compile. Either output can be a .jar or a directory.
The header-only mode avoids implementation-generated synthetic members that can appear in a header from a full compile,
so the two modes need not produce identical bytes for the same sources. Body-only edits leave the stripped header
unchanged; edits to inline bodies, constants or signatures can change it.
elide kotlinc --abi-only -- -jvm-target 21 -d lib-abi.jar Library.kt
elide kotlinc -- -jvm-target 21 -cp lib-abi.jar -d consumer.jar Consumer.kt
elide kotlinc -- -jvm-target 21 -d lib.jar Library.kt
Use lib.jar at runtime, along with the Kotlin standard library and other runtime dependencies. Passing the header
alone to elide java does not provide an implementation.
For mixed Kotlin/Java inputs, both ABI modes include Java declarations in the header. The Java header resolves against
the Kotlin header and the supplied classpath; -jvm-target sets its class-file target. A normal full Kotlin compile
reads .java files for resolution but does not emit their implementation classes: compile those separately with
elide javac. Java annotation processors are not run by this mixed-source header step.
ELIDE_KOTLINC_ABI_STRIP=0 disables body stripping for --abi-only, running full code generation before keeping the
header. This is a diagnostic fallback and does not turn the output into a runnable implementation. Workers accept the
setting per request.
Built-in compiler plugins
Elide ships the plugins below, each pinned to the compiler that loads them. A
project toggles them in the manifest; elide kotlinc takes --plugins LIST or
the matching --<name> / --no-<name> flag.
| Plugin | Manifest switch | Default |
|---|---|---|
| kotlinx.serialization | kotlin. | On |
| AtomicFU | kotlin. | On |
| Power-Assert | kotlin. | On |
| Metro (DI) | kotlin.features.metro | On for elide build, explicit for elide kotlinc |
| Compose | kotlin.features.compose | Off; defaultPlugins does not turn it on |
kotlin.features.defaultPlugins = false turns off the default suite.
Compose
Compose is opt-in because the Compose compiler fails any module whose classpath
has no Compose runtime, whether or not the sources declare @Composable. Enable
it alongside a Compose runtime dependency, which Elide does not supply:
kotlin {
features {
compose = true
}
}
elide kotlinc reads the same switch, so the two agree for one project; pass
--compose (or --plugins=compose) to request it without a manifest, and
--no-compose to force it off.
Plugin options pass through kotlin.plugins, keyed by the compiler plugin id:
kotlin {
plugins {
["androidx.compose.compiler.plugins.kotlin"] {
["reportsDestination"] = "build/compose-reports"
}
}
}
Like AGP’s debug variant, elide build adds sourceInformation=true for modules
that are compiled for a debug Android application, so previews and inspectors can
locate each composable call. A module is debug when it declares an application
(Android.AndroidApk or Android.AndroidAab) with release = false. A module that declares no
application is debug when a workspace project that depends on it, directly or
through other members, declares one. Other modules keep the compiler default, so
release APKs carry no source information. A sourceInformation entry in
kotlin.plugins takes precedence, and elide kotlinc never adds the option.
Build projects
elide build compiles Kotlin source sets found by convention or declared in elide.pkl.
kotlin {
apiLevel = "auto"
languageLevel = "auto"
compilerOptions {
allWarningsAsErrors = true
optIn { "kotlin.time.ExperimentalTime" }
freeCompilerArgs { "-Xcontext-parameters" }
}
}
| Property | Meaning | Default |
|---|---|---|
kotlin.apiLevel, kotlin.languageLevel | "2.2" … "2.5", "latest" or "stable". | "auto" |
compilerOptions.optIn | Markers passed as -opt-in. | none |
compilerOptions., .extraWarnings, .allWarningsAsErrors, .suppressWarnings, .verbose | The matching kotlinc switches. | false |
compilerOptions. | Extra compiler arguments. | none |
compilerOptions., .languageVersion, .jvmTarget | Per-compile versions; "auto" follows the project. | "auto" |
compilerOptions. | Emit parameter metadata for Java reflection. | false |
compilerOptions. | "ERROR", "WARNING" or "IGNORE" on Kotlin/Java target mismatch. | "ERROR" |
compilerOptions., .noJdk | Drop the stdlib or JDK from the classpath. | false |
compilerOptions. | Unsupported: true fails the Kotlin compile. Package with a Jvm.JvmApplication artifact. | false |
compilerOptions. | Incremental project builds. | true |
Each compile writes its arguments to kotlinc.args beside its output.
Plugins and features
kotlin.features | Effect | Default |
|---|---|---|
kotlinx | KotlinX libraries on Kotlin dependency roots. | true |
defaultPlugins | Built-in plugin suite. | true |
serialization | kotlinx.serialization plugin and runtime. | kotlinx && defaultPlugins |
coroutines | kotlinx.coroutines runtime. | kotlinx |
atomicfu | kotlinx.atomicfu plugin and runtime. | kotlinx && defaultPlugins |
powerAssert | Power Assert plugin. | defaultPlugins |
metro | Metro DI plugin. | defaultPlugins |
compose | Opt-in Compose compiler plugin; requires an explicit Compose runtime dependency. | false |
reflection | Implicit kotlin-reflect. | true |
testing | Kotlin test libraries on test sets. | true |
kotlin {
features {
metro = false
}
plugins {
["org.jetbrains.kotlinx.serialization"] {
["mode"] = "json"
}
}
}
dependencies {
maven {
kotlinPlugins { "com.example:my-compiler-plugin:1.0.0" }
}
}
- Each
pluginsentry becomes-P plugin:<id>:<key>=<value>, sorted by id and key. - Third-party plugins go in the
kotlinPluginsbucket and need aManagedKotlinToolchainorCustomKotlinToolchain. The embedded compiler warnsCustom Kotlin compiler plugins are not supported when using the embedded compiler, plugins will not be appliedand compiles without them. - A built-in plugin missing from the distribution is skipped, with its options, and warns.
- Implicit Kotlin libraries go only to dependency roots with Kotlin sources.
reflection = falsedropskotlin-reflect;compilerOptions.noStdlib = truedrops it and the stdlib. Declared dependencies stay. project("core").friend()exposes a sibling’sinternaldeclarations; see Workspaces.- A source set sees the
internaldeclarations of the sets it depends on in the same project: every set named in itsdependsOn(mainfor a test set that leaves it out), along with the sets those depend on.
Choose a toolchain
import "elide:Kotlin.pkl" as Kotlin
kotlin {
toolchain = "embedded" // the default
// toolchain = new Kotlin.ManagedKotlinToolchain { version = "2.4.0" }
// toolchain = new Kotlin.CustomKotlinToolchain { path = "/opt/kotlinc" }
}
| Toolchain | Behavior |
|---|---|
"embedded" | Elide’s bundled Kotlin. |
ManagedKotlinToolchain | Downloads that version (prereleases too) with its stdlib, reflect, test libraries and Kotlin plugins. KotlinX, Metro and other third-party versions are unchanged; check they match. |
CustomKotlinToolchain | A local Kotlin distribution; built-in plugins it lacks are skipped. |
The toolchain applies to project builds; elide kotlinc always uses the bundled compiler.
Project builds don’t run annotation processors or KSP over Kotlin sources, except KAPT for Android projects with
processors declared: Kotlin code that uses generated types must get them from an upstream source set or project.
elide kotlinc --kapt-sources and --ksp-output (below) do this for command-line and Bazel builds.
Annotation processors over Kotlin
elide kotlinc --kapt-sources gen.srcjar --kapt-classes gen.jar --processorpath dagger-compiler.jar -- \
-cp deps.jar src/**/*.kt src/**/*.java
--kapt-sources runs Java annotation processors instead of compiling, so Kotlin code can use what they generate:
compile again with the generated sources added. Processors see the Kotlin declarations as classes from an ABI header,
with no stub generation, and the Java sources as sources. References to classes processors have yet to generate don’t
stop processing; where one appears in a signature, processors see Any?, where KAPT shows error.NonExistentClass.
| Option | Purpose |
|---|---|
--kapt-sources PATH | Write generated sources to this srcjar. |
--kapt-classes PATH | Write generated classes and resources to this jar. |
--kapt-stubs PATH | Write the Kotlin header processors read to this jar. |
--processorpath PATHS | Processor classpath. |
--processors LIST | Processor classes to run; otherwise discovered on the processor path. |
--processor-option K=V | Processor option, like javac -AK=V; repeatable. |
Kotlin Symbol Processing
elide kotlinc --ksp-output gen --processorpath moshi-kotlin-codegen.jar:moshi.jar -- -cp moshi.jar src/**/*.kt
--ksp-output (or either jar option) runs KSP2 symbol processors instead of compiling, then compile again with the
generated sources added.
KSP2 runs in the bundled toolchain and uses its Kotlin version. Supply KSP2 processors on --processorpath with each
processor’s dependencies; Elide supplies the Kotlin standard library and KSP runtime. Providers are discovered through
META-INF/services/com.google.devtools.ksp.processing.SymbolProcessorProvider in those JARs. --processors selects
Java annotation processors for the separate --kapt-sources mode; it does not select KSP providers.
| Option | Purpose |
|---|---|
--ksp-output DIR | Write generated Kotlin to DIR/kotlin, Java to DIR/java, resources to DIR/resources, classes to DIR/classes. |
--ksp-sources PATH | Write generated Kotlin and Java sources to this srcjar. |
--ksp-classes PATH | Write generated classes and resources to this jar. |
--processorpath PATHS | Processor classpath. |
--processor-option K=V | Processor option; repeatable. |
KSP options go before --; compiler source, classpath and target options go after it. The following example assumes a
processor JAR that generates example.AppGenerated from src/App.kt:
elide kotlinc --ksp-output gen --processorpath processor.jar:processor-deps.jar \
--processor-option mode=production -- \
-jvm-target 21 -cp annotations.jar src/App.kt
elide kotlinc -- -jvm-target 21 -cp annotations.jar -d app.jar \
src/App.kt gen/kotlin/example/AppGenerated.kt
The first command only processes symbols; -d does not request an application compile in that mode. Add every generated
source needed by the second command. If the processor generates Java, pass those sources for Kotlin resolution and
compile them separately with elide javac, using the Kotlin output on its classpath. Copy generated resources into the
application’s packaged resources; they are not compiled Kotlin sources.
Use archive outputs when a build system needs explicit processing artifacts:
elide kotlinc --ksp-sources gen.srcjar --ksp-classes gen.jar \
--processorpath processor.jar:processor-deps.jar -- -cp annotations.jar src/App.kt
Either archive option activates KSP even without --ksp-output. The sources archive contains generated Kotlin and Java;
the classes archive contains classes and resources emitted by processors, not compiled application classes. Supplying
--ksp-output as well keeps the directory outputs too. KSP2 processing, Java annotation processing and Kotlin compiler
plugins are separate phases; project kotlin.plugins configuration does not schedule KSP. Project builds do not yet
run this processing phase automatically.
Samples
Start from a template:
elide init --template ktjvm # Kotlin app with a test