Community Plugins

The GitHub sbt Organization

The sbt organization is available for use by any sbt plugin. Developers who contribute their plugins into the community organization will still retain control over their repository and its access. The goal of the sbt organization is to organize sbt software into one central location.

A side benefit to using the sbt organization for projects is that you can use gh-pages to host websites under the https://www.scala-sbt.org domain.

The sbt autoplugin giter8 template is a good place to start. This sets up a new sbt plugin project appropriately. The generated README includes a summary of the steps for publishing a new community plugin.

Plugins available for sbt 2.x

[Edit] this page to submit a pull request that adds your plugin to the list.

### Code formatter plugins

One jar plugins

Verification plugins

Language support plugins

  • sbt-frege: build Frege code with sbt.
  • sbt-cc: compile C and C++ source files with sbt.

Release plugins

- [sbt-native-packager](https://github.com/sbt/sbt-native-packager) ([docs](https://sbt-native-packager.readthedocs.io/en/stable/)): build native packages (RPM, .deb etc) for your projects. - [sbt-pack](https://github.com/xerial/sbt-pack): create runnable distributions for your projects. - [sbt-release](https://github.com/sbt/sbt-release): create a customizable release process.
  • sbt-pgp: sign artefacts using PGP/GPG and manage signing keys.
- [sbt-docker](https://github.com/marcuslonnberg/sbt-docker): create and push Docker images. - [sbt-aether-deploy](https://github.com/arktekk/sbt-aether-deploy): publish artefacts using Eclipse Aether. - [sbt-rig](https://github.com/Verizon/sbt-rig): opinionated common release steps. - [sbt-s3](https://github.com/sbt/sbt-s3): manage objects on Amazon S3. - [sbt-osgi](https://github.com/sbt/sbt-osgi): create OSGi bundles. - [sbt-github-release](https://github.com/ohnosequences/sbt-github-release): publish Github releases. - [sbt-hadoop](https://github.com/Tapad/sbt-hadoop-oss): publish artifacts to the [Hadoop](https://hadoop.apache.org) Distributed File System (HDFS). - [sbt-publish-more](https://github.com/laughedelic/sbt-publish-more): publish artifacts to several repositories - [sbt-deploy](https://github.com/amanjpro/sbt-deploy-plugin): create deployable fat JARs. - [sbt-release-fossil](https://chiselapp.com/user/twenstar/repository/sbt-release-fossil): enhances [sbt-release](https://github.com/sbt/sbt-release) to support [Fossil](https://fossil-scm.org) repositories - [sbt-autoversion](https://github.com/sbt/sbt-autoversion): automatically set your next version bump based on patterns of your commit message since last release. - [sbt-gcs](https://github.com/saint1991/sbt-gcs): manage objects on Google Cloud Storage. - [sbt-sourcebundler](https://github.com/kotobotov/sbt-sourcebundler): merge all source code into one scala file. - [sbt-kubeyml](https://github.com/vaslabs/sbt-kubeyml): Create a typesafe kubernetes Deployment based on your project settings - [sbt-k8s](https://github.com/hnaderi/sbt-k8s): Create any manifest or use provided cookbooks using [scala-k8s](https://github.com/hnaderi/scala-k8s) library - [sbt-release-notes](https://github.com/AmadeusITGroup/sbt-release-notes): provide a Release Step for [sbt-release](https://github.com/sbt/sbt-release) to automatically update the release notes file.

Deployment integration plugins

  • sbt-heroku: deploy applications directly to Heroku.
  • sbt-docker-compose: launch Docker images using docker compose.
  • sbt-appengine deploy your webapp to Google App Engine.
  • sbt-marathon: deploy applications on Apache Mesos using the Marathon framework.
  • sbt-riotctl: deploy applications as systemd services directly to a Raspberry Pi, ensuring dependencies (e.g. wiringpi) are met.
  • sbt-kind: load built docker images into a kind cluster.

IDE integration plugins

Test plugins

  • scripted: integration testing for sbt plugins.
  • sbt-jmh: run Java Microbenchmark Harness (JMH) benchmarks from sbt.
  • gatling-sbt: performance and load-testing using Gatling.
  • sbt-multi-jvm: run tests using multiple JVMs.
  • sbt-scalaprops: scalaprops property-based testing integration.
  • sbt-testng: TestNG framework integration.
  • sbt-jcstress: Java Concurrency Stress Test (jcstress) integration.
  • sbt-cached-ci: Incremental sbt builds for CI environments.

Library dependency plugins

Web and frontend development plugins

  • sbt-web: library for building sbt plugins for the web.

Database plugins

Code generator plugins

  • sbt-scalaxb: generate model classes from XML schemas and WSDL.

  • sbt-protobuf: protobuf code generator.

  • sbt-header: auto-generate source code file headers (such as copyright notices).

  • sbt-boilerplate: TupleX and FunctionX boilerplate code generator.

  • sbt-avro: Apache Avro schema and protocol generator.

  • sbt-aspectj: AspectJ weaving for sbt.

  • sbt-protoc: protobuf code generator using protoc.

  • sbt-contraband (docs): generate pseudo-case classes from GraphQL schemas.

  • sbt-antlr4: run ANTLR v4 from sbt.

  • sbt-sql: generate model classes from SQL.

  • sbt-partial-unification: enable partial unification support in Scala (SI-2712).

  • sbt-i18n: transform your i18n bundles into Scala code.

  • sbt-lit: build literate code with sbt.

  • sbt-embedded-files: generate Scala objects containing the contents of glob-specified files as strings or byte-arrays.

  • sbt-scala-ts: generate TypeScript code according compiled Scala types (case class, trait, object, ...).

Static code analysis plugins

Utility and system plugins

- [sbt-revolver](https://github.com/spray/sbt-revolver): auto-restart forked JVMs on update. - [sbt-conscript](https://github.com/foundweekends/conscript) ([docs](https://www.foundweekends.org/conscript/)): distribute apps using GitHub and Maven Central. - [sbt-errors-summary](https://github.com/Duhemm/sbt-errors-summary): show a summary of compilation errors. - [MiMa](https://github.com/lightbend/mima): binary compatibility management for Scala libraries. - [sbt-groll](https://github.com/sbt/sbt-groll): navigate git history inside sbt. - [sbt-dynver](https://github.com/sbt/sbt-dynver): set project version dynamically from git metadata. - [sbt-prompt](https://github.com/agemooij/sbt-prompt): add promptlets and themes to your sbt prompt. - [sbt-crossproject](https://github.com/portable-scala/sbt-crossproject): cross-build Scala, Scala.js and Scala Native. - [sbt-proguard](https://github.com/sbt/sbt-proguard): run ProGuard on compiled sources. - [sbt-structure](https://github.com/JetBrains/sbt-structure): extract project structure in XML format. - [sbt-jni](https://github.com/sbt/sbt-jni): helpers for working with projects that use JNI. - [sbt-jol](https://github.com/ktoso/sbt-jol): inspect OpenJDK Java Object Layout from sbt. - [sbt-musical](https://github.com/tototoshi/sbt-musical): control iTunes from sbt (Mac only). - [sbt-travisci](https://github.com/dwijnand/sbt-travisci): integration with Travis CI. - [horder](https://github.com/romanowski/hoarder): cache compilation artefacts for future builds. - [sbt-javaagent](https://github.com/sbt/sbt-javaagent): add Java agents to projects. - [sbt-jshell](https://github.com/xuwei-k/sbt-jshell): Java REPL for sbt. - [sbt-check](https://github.com/jeffreyolchovy/sbt-check): compile up to, and including, the typer phase. - [sbt-mima-version-check](https://github.com/ChristopherDavenport/sbt-mima-version-check): Automate which Mima Versions to Check - [sbt-tmpfs](https://github.com/cuzfrog/sbt-tmpfs): utilize tmpfs to speed up builds. - [sbt-sh](https://github.com/melezov/sbt-sh): run shell commands from sbt. - [sbt-ammonite-classpath](https://github.com/ThoughtWorksInc/sbt-ammonite-classpath): export classpath for [Ammonite](https://ammonite.io/) and [Almond](https://almond.sh/). - [sbt-version-scheme-enforcer-plugin](https://github.com/isomarcte/sbt-version-scheme-enforcer): Derive Mima settings for your library from your declared `versionScheme`. This supports Early SemVer, Strict SemVer, and Package Versioning Policy (PVP). - [sbt-dotenv](https://github.com/philippus/sbt-dotenv): load environment variables from .env into the JVM System Environment for local development.
### Documentation plugins

  • tut: documentation and tutorial generator.

  • Laika: Transform Markdown or reStructuredText into HTML or PDF with Templating.

  • sbt-site: site generator.

  • sbt-microsites: generate and publish microsites using Jekyll.

  • sbt-unidoc: create unified API documentation across subprojects.

  • sbt-ghpages: publish generated sites to GitHub pages.

  • sbt-class-diagram: generate class diagrams from Scala source code.

  • sbt-api-mappings: generate Scaladoc apiMappings for common Scala libraries.

  • literator: generate literate-style markdown docs from your sources.

  • sbt-example:  generate ScalaTest test suites from examples in Scaladoc.

  • sbt-delombok:  delombok Java sources files that contain Lombok annotations to make Javadoc contain Lombok-generated classes and methods.

  • sbt-alldocs: collect all the docs for a project and dependencies into a single folder.

  • sbt-apidoc: A port of apidocjs to sbt, to document REST Api.

  • sbt-github-pages (docs): publish a website to GitHub Pages with minimal effort - works well with GitHub Actions.

  • sbt-docusaur (docs): build a website using Docusaurus and publish to GitHub Pages with minimal effort - works well with GitHub Actions.

  • sbt-hl-compiler: compile the code snippets from documentation (to keep it consistent).

  • sbt-scaladoc-compiler: compile the code snippets included in Scaladoc comments.

### Code coverage plugins

Create new project plugins

  • sbt-fresh: create an opinionated fresh sbt project.

Framework-specific plugins

  • sbt-newrelic: NewRelic support for artefacts built with sbt-native-packager.
  • sbt-spark: Spark application configurator.
  • sbt-api-builder: support for ApiBuilder from within sbt's shell.