sbtnativepackager

Sbtnativepackager is a plugin for the Scala Build Tool (SBT) that provides native packaging capabilities for applications built with Scala and Java. It is commonly referred to in discussions as sbt-native-packager, with sbtnativepackager serving as an informal shorthand. The plugin streamlines the creation of platform-specific distributions from an SBT project.

The plugin enables packaging into a variety of native formats across major operating systems. Typical packaging targets include deb and rpm Linux packages, Windows executables, macOS installers (such as dmg or pkg), and cross-platform archives like zip or tar.gz. It also supports the creation of launch scripts, wrapper environments, and minimal runtime environments as part of the produced distribution. By integrating with SBT’s build lifecycle, the plugin allows teams to produce consistent, distributable artifacts directly from their build definition.

Usage and configuration are centered in the project’s build files. To use the plugin, it is added in a plugins file and then enabled in the project by selecting one of the packaging modules, such as JavaAppPackaging or JavaServerAppPackaging. Typical configuration covers metadata and naming, versioning, and platform-specific preferences, including packageName, version, maintainer, description, license, and dependencies. Users can customize install or post-install scripts, file mappings, and resource inclusion, as well as tailor the distribution layout to the target platform.

The project is maintained by the Scala and sbt community and is widely adopted in Scala-based deployment workflows. It emphasizes cross-platform packaging while preserving sbt’s declarative build model, enabling developers to produce repeatable, platform-ready artifacts from a single source of truth.

See also: sbt, sbt-native-packager, software packaging.