Karbone

A modern Kotlin SDK for the Carbone.io document generation API.

Karbone aims to replace the official carbone-sdk-java, which is incomplete and no longer keeps up with the Carbone API, with an idiomatic, fully typed Kotlin client.

Status: early public release (0.x). The API may still change between minor versions.

Installation

dependencies {
    implementation("com.ekino.oss:karbone:0.2.0")
}

Snapshots are published to the Maven Central snapshot repository:

repositories {
    mavenCentral()
    maven { url = uri("https://central.sonatype.com/repository/maven-snapshots/") }
}

Documentation

Guides and the generated API reference: https://ekino.github.io/Karbone/

• Quickstart · Configuration
• Rendering · Templates · Errors
• On-premise · Testing · Logging
• API reference

The site is built from docs/ (Quarkdown) and ./gradlew dokkaGenerate (Dokka, build/dokka/html).

Development

Requires JDK 21.

./gradlew spotlessApply   # format and add license headers
./gradlew build           # compile, detekt, spotlessCheck, tests
./gradlew kotest          # run tests with the Kotest reporter

License

MIT © 2026 ekino