RIDDL Documentation
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage


RIDDL provides an
SBT plugin for convenience in other projects that want to run riddlc easily from SBT.

To install the SBT plugin all you need to do is add the following to your project/plugins.sbt file:

addSbtPlugin("com.reactific" %% "sbt-riddl" % "{version}")

Make sure to replace {version} with an appropriate version

Then, specify options in your build.sbt file like this:

// Enable the plugin you installed
// Specify the options to riddlc that you want to run when the `compile` 
// command is used. This allows riddlc to be a code generator
riddlcOptions := Seq(
  "--verbose", "from", "path/to/config/file", "hugo"
// Specify the minimum riddlc version to processor you RIDDL specification
riddlcMinVersion := "0.14.0"

The riddlcOptions setting provides all the options to riddlc that you want to run during compile. You would specify in this setting all the needed options to cause riddlc to generate your sources, presumably used in subsequent compilation steps.