README.adoc

July 8, 2026 · View on GitHub

:projectKey: ai.timefold:timefold-solver :sonarBadge: image:https://sonarcloud.io/api/project_badges/measure?project={projectKey} :sonarLink: link="https://sonarcloud.io/dashboard?id={projectKey}" :branch: main

image::docs/src/modules/ROOT/images/shared/timefold-solver-logo.png[link="https://solver.timefold.ai",Timefold,align="center"]

Planning optimization made easy. + https://timefold.ai[timefold.ai]

image:https://img.shields.io/github/discussions/TimefoldAI/timefold-solver?style=for-the-badge&logo=github["GitHub Discussions", link="https://github.com/TimefoldAI/timefold-solver/discussions"] image:https://img.shields.io/discord/1413420192213631086?style=for-the-badge&logo=discord&logoColor=white["Community Discord", link="https://discord.gg/bW8tUUeBzH"] image:https://img.shields.io/github/commit-activity/m/TimefoldAI/timefold-solver?label=commits&style=for-the-badge["Commit Activity", link="https://github.com/TimefoldAI/timefold-solver/pulse"] image:https://img.shields.io/github/issues/TimefoldAI/timefold-solver?style=for-the-badge&logo=github["GitHub Issues", link="https://github.com/TimefoldAI/timefold-solver/issues"]

{sonarBadge}&style=for-the-badge&metric=reliability_rating["Reliability Rating", {sonarLink}] {sonarBadge}&metric=security_rating["Security Rating", {sonarLink}] {sonarBadge}&metric=sqale_rating["Maintainability Rating", {sonarLink}]

Timefold Solver is an AI constraint solver for Java and Kotlin. You can use Timefold Solver to optimize the Vehicle Routing Problem, Employee Rostering, Maintenance Scheduling, Task Assignment, School Timetabling, Cloud Optimization, Conference Scheduling, Job Shop Scheduling and many more planning problems.

Developed by the original OptaPlanner team, our aim is to free the world of wasteful planning.

== Get started with Timefold Solver in Java

image:https://img.shields.io/maven-central/v/ai.timefold.solver/timefold-solver-bom?logo=apache-maven&style=for-the-badge["Maven artifact", link="https://ossindex.sonatype.org/component/pkg:maven/ai.timefold.solver/timefold-solver-bom"] image:https://img.shields.io/badge/Java-21+-brightgreen.svg?style=for-the-badge["JVM support", link="https://sdkman.io"]

== Build from source

. Install JDK 21+ and Maven 3.9.11+, for example with https://sdkman.io[Sdkman]: +

sdkinstalljavasdk install java sdk install maven

. Git clone this repository: +

gitclonehttps://github.com/TimefoldAI/timefold−solver.gitgit clone https://github.com/TimefoldAI/timefold-solver.git cd timefold-solver

. Build it from source: +

$ ./mvnw clean install -Dquickly

== Contribute

This is an open source project, and you are more than welcome to contribute! For more, see link:CONTRIBUTING.md[Contributing].

== Editions

There are two editions of Timefold Solver:

  • Timefold Solver Community Edition,
  • Timefold Solver Enterprise.

The Community Edition (this repo) is open-source and licensed under the Apache-2.0 license. The Enterprise Edition is a non-open-source commercial offering and requires a Timefold license to run.

https://licenses.timefold.ai/[See which edition is right for you.]

== Legal notice

Timefold Solver was https://timefold.ai/blog/2023/optaplanner-fork/[forked] on 20 April 2023 from OptaPlanner, which was entirely Apache-2.0 licensed (a permissive license).

Timefold Solver is a derivative work of OptaPlanner and OptaPy, which includes copyrights of the original creator, Red Hat Inc., affiliates, and contributors, that were all entirely licensed under the Apache-2.0 license. Every source file has been modified.

=== Documentation icon libraries