elide.pkl Reference

Every Elide project manifest starts with the project schema:

amends "elide:project.pkl"

This page is the field reference for the schema in protocol/manifest/*.pkl. It lists the properties accepted by Elide today. When a property is parsed but not currently consumed by a build or runtime path, that is called out.

Top-level Properties

Two read-only objects are also available during evaluation:

Sources

Import Sources.pkl when using the structured form:

import "elide:Sources.pkl" as Sources

sources {
  ["main"] = new Sources.SourceSetSpec {
    type = "source"
    paths {
      "src/main/java/**/*.java"
      "src/main/kotlin/**/*.kt"
    }
  }
}

sources is a mapping from source-set name to either a simple glob string or a SourceSetSpec.

The default manifest defines main = "src/**.*" and test = "test/**.*". Default source sets other than main depend on main.

Jvm.JvmSourceSetSpec extends SourceSetSpec with:

Dependencies

dependencies {
  npm {
    packages { "react@19.0.0" }
  }
  pypi {
    packages { "six==1.17.0" }
  }
  maven {
    packages { "com.google.guava:guava:33.4.8-jre" }
  }
}

npm

PyPI

Maven

Import Jvm.pkl for structural Maven dependencies or repositories:

import "elide:Jvm.pkl" as Jvm

dependencies {
  maven {
    packages {
      "com.google.guava:guava:33.4.8-jre"
      new Jvm.MavenPackageSpec {
        group = "com.google.guava"
        name = "guava"
        version = "33.4.8-jre"
      }
    }
  }
}

Maven dependency buckets accept coordinate strings, MavenPackageSpec, or local JAR paths. Coordinate strings may use group:artifact, group:artifact:version, Gradle-style group:artifact:version:classifier, or Aether-style group:artifact:extension:classifier:version.

MavenPackageSpec:

MavenRepositorySpec:

JVM

jvm {
  main = "example.Main"
  target = 25
  java {
    compiler {
      flags { "-Xlint:all" }
    }
  }
}

features:

java:

Kotlin

kotlin {
  compilerOptions {
    allWarningsAsErrors = true
    jvmTarget = 25
  }
}

compilerOptions:

features:

toolchain may be "embedded", new Kotlin.ManagedKotlinToolchain { version = "..." }, or new Kotlin.CustomKotlinToolchain { path = "..." }.

JavaScript

javascript {
  ecma = "latest"
}

Native Image

Project-wide nativeImage {} uses the same option shape as native-image artifacts. For build outputs, set options {} on NativeImage.NativeImage artifacts so the options are tied to the target being built.

linkAtBuildTime:

classInit:

exclusions:

pgo:

Engine

Dev

import "elide:Dev.pkl" as Dev

dev {
  mcp {
    registerElide = true
    advice = true
  }
}

source:

mcp:

McpResource:

server:

Toolchain

toolchain {
  engines {
    ["elide"] = "1.4.0"
  }
}

EngineSettings:

Artifacts

Every artifact has:

JAR

import "elide:Jvm.pkl" as Jvm

artifacts {
  ["app"] = new Jvm.Jar {
    name = "app.jar"
    main = "example.Main"
  }
}

Sources JAR

Javadoc JAR

Native Image Artifact

import "elide:NativeImage.pkl" as NativeImage

artifacts {
  ["native"] = new NativeImage.NativeImage {
    from { "app" }
    entrypoint = "example.Main"
  }
}

options accepts the same fields listed in Native Image.

Static Site

import "elide:Web.pkl" as Web

artifacts {
  ["site"] = new Web.StaticSite {
    srcs = "site"
    prefix = "/"
  }
}

Container Image

import "elide:Container.pkl" as Container

artifacts {
  ["image"] = new Container.ContainerImage {
    image = "example/app"
    from { "native" }
    tags { "latest" }
  }
}

Web

import "elide:Web.pkl" as Web

web {
  css {
    targets {
      new Web.CssTarget {
        browser = "chrome"
        version = "126"
      }
    }
  }
}

css:

CssTarget:

Testing

import "elide:Jvm.pkl" as Jvm
import "elide:Testing.pkl" as Testing

testing {
  reports {
    Testing.xmlReport()
  }

  coverage {
    jvm {
      enabled = true
      reports {
        new Jvm.HtmlCoverageReport {}
        new Jvm.XmlCoverageReport {}
      }
    }
  }
}

Test report classes:

JVM report classes:

Testing.pkl exports xmlReport() for test result XML. Jvm.pkl exports sourceSet(), htmlReport(), xmlReport(), and csvReport(); its report helpers configure coverage output.