sbt plugin for creating OSGi bundles
Switch branches/tags
Clone or download
Pull request Compare This branch is 4 commits behind typesafehub:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.



Plugin for sbt to create OSGi bundles.

Installing sbtosgi

Just add the following line to your plugin definition (plugins.sbt file in the project/ folder of your project or plugins.sbt file in the ~/.sbt/plugins/ directory, for details about plugins see the sbt documentation), paying attention to the blank line between settings:

addSbtPlugin("com.typesafe.sbtosgi" % "sbtosgi" % "0.3.0")

If you want to use the latest and greates features, you can also give the latest snapshot release a try:

resolvers += Classpaths.typesafeSnapshots

addSbtPlugin("com.typesafe.sbtosgi" % "sbtosgi" % "0.4.0-SNAPSHOT")

Adding sbtosgi settings

Add the below line to your build definition, which will add the task osgi-bundle and also publish an OSGi bundle instead of a raw JAR archive. Again, pay attention to the blank line between settings:


If you don't want to publish an OSGi bundle instead of a raw JAR archive:


Notice that automatically publishing an OSGi bundle and defaultOsgiSettings are only available from version 0.3.0 on. If you are using an older version, you have to add the following settings to your build definition to enable publishing an OSGi bundle:

packagedArtifact in (Compile, packageBin) <<= (artifact in (Compile, packageBin), OsgiKeys.bundle).identityMap

artifact in (Compile, packageBin) ~= (_.copy(`type` = "bundle"))

Configuring sbtosgi

This plugin comes with the following configuration options, available as sbt settings:

  • OsgiKeys.bundleActivator: Optional value for Bundle-Activator header, default is None
  • OsgiKeys.bundleSymbolicName: Value for Bundle-SymbolicName header, default is organization plus name
  • OsgiKeys.bundleVersion: Value for Bundle-Version header, default is version
  • OsgiKeys.dynamicImportPackage: Values for Dynamic-ImportPackage header, default is the empty sequence
  • OsgiKeys.export-package: Values for Export-Package header, default is the empty sequence
  • OsgiKeys.importPackage: Values for Import-Package header, default is "*"
  • OsgiKeys.fragmentHost: Optional value for Fragment-Host header, default is None
  • OsgiKeys.privatePackage: Values for Private-Package header, default is OsgiKeys.bundleSymbolicName plus ".*"
  • OsgiKeys.requireBundle: Values for Require-Bundle header, default is the empty sequence
  • OsgiKeys.additionalHeaders: Map of additional headers to be passed to BND, default is the empty sequence

Mailing list

Please use the sbt mailing list and prefix the subject with "[sbtosgi]".

Contribution policy

Contributions via GitHub pull requests are gladly accepted from their original author. Before we can accept pull requests, you will need to agree to the Typesafe Contributor License Agreement online, using your GitHub account - it takes 30 seconds.


This code is open source software licensed under the Apache 2.0 License. Feel free to use it accordingly.