sbt-native-packager
API
Generated with
sbt-native-packager/com.typesafe.sbt/com.typesafe.sbt.packager/Keys

Keys

com.typesafe.sbt.packager.Keys
object Keys extends NativePackagerKeys, UniversalKeys, LinuxKeys, WindowsKeys, DockerKeys, DebianKeys, RpmKeys, JavaAppKeys, JavaServerAppKeys, SystemloaderKeys, BashStartScriptKeys, BatStartScriptKeys, ValidationKeys

This Keys object can be used for

  • non autoplugin builds
  • import single keys, which are not inside the autoImport

==Non autoplugin builds==

import com.typesafe.sbt.packager.Keys._

packageName := ""

==autoplugin builds==

NativePackagerKeys.packageName := ""

Attributes

Graph
Supertypes
trait JavaAppKeys
trait RpmKeys
trait DebianKeys
trait DockerKeys
trait WindowsKeys
trait LinuxKeys
class Object
trait Matchable
class Any
Show all
Self type
Keys.type

Members list

Value members

Inherited fields

val bashForwarderTemplateLocation: TaskKey[Option[File]]

Attributes

Inherited from:
BashStartScriptKeys
val bashScriptConfigLocation: TaskKey[Option[String]]

Attributes

Inherited from:
BashStartScriptKeys
val bashScriptDefines: TaskKey[Seq[String]]

Attributes

Inherited from:
BashStartScriptKeys
val bashScriptEnvConfigLocation: SettingKey[Option[String]]

Attributes

Inherited from:
JavaAppKeys
val bashScriptExtraDefines: TaskKey[Seq[String]]

Attributes

Inherited from:
BashStartScriptKeys
val bashScriptReplacements: TaskKey[Seq[(String, String)]]

Attributes

Inherited from:
BashStartScriptKeys
val bashScriptTemplateLocation: TaskKey[File]

Attributes

Inherited from:
BashStartScriptKeys
val batForwarderTemplateLocation: TaskKey[Option[File]]

Attributes

Inherited from:
BatStartScriptKeys
val batScriptConfigLocation: TaskKey[Option[String]]

Attributes

Inherited from:
BatStartScriptKeys
val batScriptExtraDefines: TaskKey[Seq[String]]

Attributes

Inherited from:
BatStartScriptKeys
val batScriptReplacements: TaskKey[Seq[(String, String)]]

Attributes

Inherited from:
BatStartScriptKeys
val batScriptTemplateLocation: TaskKey[File]

Attributes

Inherited from:
BatStartScriptKeys
val bundledJvmLocation: TaskKey[Option[String]]

Attributes

Inherited from:
JavaAppKeys2 (hidden)
val candleOptions: SettingKey[Seq[String]]

Attributes

Inherited from:
WindowsKeys
val containerBuildImage: TaskKey[Option[String]]

Attributes

Inherited from:
UniversalKeys
val daemonGroup: SettingKey[String]

Attributes

Inherited from:
LinuxKeys
val daemonGroupGid: SettingKey[Option[String]]

Attributes

Inherited from:
LinuxKeys
val daemonHome: SettingKey[String]

Attributes

Inherited from:
LinuxKeys
val daemonShell: SettingKey[String]

Attributes

Inherited from:
LinuxKeys
val daemonStdoutLogFile: SettingKey[Option[String]]

Attributes

Inherited from:
JavaServerAppKeys
val daemonUser: SettingKey[String]

Attributes

Inherited from:
LinuxKeys
val daemonUserUid: SettingKey[Option[String]]

Attributes

Inherited from:
LinuxKeys
val debianChangelog: SettingKey[Option[File]]

Attributes

Inherited from:
DebianKeys
val debianCombinedMappings: TaskKey[Seq[LinuxPackageMapping]]

Attributes

Inherited from:
DebianKeys
val debianConffilesFile: TaskKey[File]

Attributes

Inherited from:
DebianKeys
val debianControlFile: TaskKey[File]

Attributes

Inherited from:
DebianKeys
val debianControlScriptsDirectory: SettingKey[File]

Attributes

Inherited from:
DebianKeys
val debianLinksfile: TaskKey[File]

Attributes

Inherited from:
DebianKeys
val debianMD5sumsFile: TaskKey[File]

Attributes

Inherited from:
DebianKeys
val debianMakeChownReplacements: TaskKey[(String, String)]

Attributes

Inherited from:
DebianKeys
val debianNativeBuildOptions: SettingKey[Seq[String]]

Attributes

Inherited from:
DebianKeys
val debianPackageConflicts: SettingKey[Seq[String]]

Attributes

Inherited from:
DebianKeys
val debianPackageDependencies: SettingKey[Seq[String]]

Attributes

Inherited from:
DebianKeys
val debianPackageInfo: SettingKey[PackageInfo]

Attributes

Inherited from:
DebianKeys
val debianPackageInstallSize: TaskKey[Long]

Attributes

Inherited from:
DebianKeys
val debianPackageMetadata: SettingKey[PackageMetaData]

Attributes

Inherited from:
DebianKeys
val debianPackageProvides: SettingKey[Seq[String]]

Attributes

Inherited from:
DebianKeys
val debianPackageRecommends: SettingKey[Seq[String]]

Attributes

Inherited from:
DebianKeys
val debianPriority: SettingKey[String]

Attributes

Inherited from:
DebianKeys
val debianSection: SettingKey[String]

Attributes

Inherited from:
DebianKeys
val debianSign: TaskKey[FileRef]

Attributes

Inherited from:
DebianKeys
val debianSignRole: SettingKey[String]

Attributes

Inherited from:
DebianKeys
val debianUpstartFile: TaskKey[File]

Attributes

Inherited from:
DebianKeys
val debianZippedMappings: TaskKey[Seq[LinuxPackageMapping]]

Attributes

Inherited from:
DebianKeys
val defaultLinuxConfigLocation: SettingKey[String]

Attributes

Inherited from:
LinuxKeys
val defaultLinuxInstallLocation: SettingKey[String]

Attributes

Inherited from:
LinuxKeys
val defaultLinuxLogsLocation: SettingKey[String]

Attributes

Inherited from:
LinuxKeys
val defaultLinuxStartScriptLocation: SettingKey[String]

Attributes

Inherited from:
LinuxKeys
val dist: TaskKey[FileRef]

Attributes

Inherited from:
UniversalKeys
val dockerAlias: SettingKey[DockerAlias]

Attributes

Inherited from:
DockerKeys
val dockerAliases: SettingKey[Seq[DockerAlias]]

Attributes

Inherited from:
DockerKeys
val dockerAutoremoveMultiStageIntermediateImages: SettingKey[Boolean]

Attributes

Inherited from:
DockerKeys
val dockerBaseImage: SettingKey[String]

Attributes

Inherited from:
DockerKeys
val dockerBuildCommand: SettingKey[Seq[String]]

Attributes

Inherited from:
DockerKeys
val dockerBuildEnvVars: SettingKey[Map[String, String]]

Attributes

Inherited from:
DockerKeys
val dockerBuildOptions: SettingKey[Seq[String]]

Attributes

Inherited from:
DockerKeys
val dockerCmd: SettingKey[Seq[String]]

Attributes

Inherited from:
DockerKeys
val dockerCommands: TaskKey[Seq[CmdLike]]

Attributes

Inherited from:
DockerKeys
val dockerEntrypoint: SettingKey[Seq[String]]

Attributes

Inherited from:
DockerKeys
val dockerEnvVars: SettingKey[Map[String, String]]

Attributes

Inherited from:
DockerKeys
val dockerExecCommand: SettingKey[Seq[String]]

Attributes

Inherited from:
DockerKeys
val dockerExposedPorts: SettingKey[Seq[Int]]

Attributes

Inherited from:
DockerKeys
val dockerExposedUdpPorts: SettingKey[Seq[Int]]

Attributes

Inherited from:
DockerKeys
val dockerExposedVolumes: SettingKey[Seq[String]]

Attributes

Inherited from:
DockerKeys
val dockerGenerateConfig: TaskKey[File]

Attributes

Inherited from:
DockerKeys
val dockerLabels: SettingKey[Map[String, String]]

Attributes

Inherited from:
DockerKeys
val dockerPackageMappings: TaskKey[Seq[(FileRef, String)]]

Attributes

Inherited from:
DockerKeys
val dockerRepository: SettingKey[Option[String]]

Attributes

Inherited from:
DockerKeys
val dockerRmiCommand: SettingKey[Seq[String]]

Attributes

Inherited from:
DockerKeys
val dockerUpdateLatest: SettingKey[Boolean]

Attributes

Inherited from:
DockerKeys
val dockerUsername: SettingKey[Option[String]]

Attributes

Inherited from:
DockerKeys
val dockerVersion: TaskKey[Option[DockerVersion]]

Attributes

Inherited from:
DockerKeys
val executableScriptName: SettingKey[String]

Attributes

Inherited from:
NativePackagerKeys
val fileDescriptorLimit: SettingKey[Option[String]]

Attributes

Inherited from:
LinuxKeys
val genChanges: TaskKey[FileRef]

Attributes

Inherited from:
DebianKeys
val generateManPages: TaskKey[Unit]

Attributes

Inherited from:
LinuxKeys
val jlinkBuildImage: TaskKey[File]

Attributes

Inherited from:
JlinkKeys (hidden)
val jlinkBundledJvmLocation: TaskKey[String]

Attributes

Inherited from:
JlinkKeys (hidden)
val jlinkIgnoreMissingDependency: TaskKey[((String, String)) => Boolean]

Attributes

Inherited from:
JlinkKeys (hidden)
val jlinkModulePath: TaskKey[Seq[File]]

Attributes

Inherited from:
JlinkKeys (hidden)
val jlinkModules: TaskKey[Seq[String]]

Attributes

Inherited from:
JlinkKeys (hidden)
val jlinkOptions: TaskKey[Seq[String]]

Attributes

Inherited from:
JlinkKeys (hidden)
val killTimeout: SettingKey[Int]

Attributes

Inherited from:
SystemloaderKeys
val lightOptions: SettingKey[Seq[String]]

Attributes

Inherited from:
WindowsKeys
val lintian: TaskKey[Unit]

Attributes

Inherited from:
DebianKeys
val linuxEtcDefaultTemplate: TaskKey[URL]

Attributes

Inherited from:
LinuxKeys
val linuxMakeStartScript: TaskKey[Option[File]]

Attributes

Inherited from:
LinuxKeys
val linuxPackageMappings: TaskKey[Seq[LinuxPackageMapping]]

Attributes

Inherited from:
LinuxKeys
val linuxScriptReplacements: SettingKey[Seq[(String, String)]]

Attributes

Inherited from:
LinuxKeys
val linuxStartScriptName: SettingKey[Option[String]]

Attributes

Inherited from:
LinuxKeys
val linuxStartScriptTemplate: TaskKey[URL]

Attributes

Inherited from:
LinuxKeys
val maintainer: SettingKey[String]

Attributes

Inherited from:
NativePackagerKeys
val maintainerScripts: TaskKey[Map[String, Seq[String]]]

Attributes

Inherited from:
NativePackagerKeys
val makeBashScripts: TaskKey[Seq[(FileRef, String)]]

Attributes

Inherited from:
BashStartScriptKeys
val makeBatScripts: TaskKey[Seq[(FileRef, String)]]

Attributes

Inherited from:
BatStartScriptKeys
val makeEtcDefault: TaskKey[Option[File]]

Attributes

Inherited from:
LinuxKeys
val packageArchitecture: SettingKey[String]

Attributes

Inherited from:
LinuxKeys
val packageDescription: SettingKey[String]

Attributes

Inherited from:
NativePackagerKeys
val packageName: SettingKey[String]

Attributes

Inherited from:
NativePackagerKeys
val packageOsxDmg: TaskKey[FileRef]

Attributes

Inherited from:
UniversalKeys
val packageSummary: SettingKey[String]

Attributes

Inherited from:
NativePackagerKeys
val packageXzTarball: TaskKey[FileRef]

Attributes

Inherited from:
UniversalKeys
val packageZipTarball: TaskKey[FileRef]

Attributes

Inherited from:
UniversalKeys
val projectDependencyArtifacts: TaskKey[Seq[Attributed[FileRef]]]

Attributes

Inherited from:
JavaAppKeys
val requiredStartFacilities: SettingKey[Option[String]]

Attributes

Inherited from:
SystemloaderKeys
val requiredStopFacilities: SettingKey[Option[String]]

Attributes

Inherited from:
SystemloaderKeys
val retries: SettingKey[Int]

Attributes

Inherited from:
SystemloaderKeys
val retryTimeout: SettingKey[Int]

Attributes

Inherited from:
SystemloaderKeys
val rpmAutoprov: SettingKey[String]

Attributes

Inherited from:
RpmKeys
val rpmAutoreq: SettingKey[String]

Attributes

Inherited from:
RpmKeys
val rpmBrpJavaRepackJars: SettingKey[Boolean]

Attributes

Inherited from:
RpmKeys
val rpmChangelogFile: SettingKey[Option[String]]

Attributes

Inherited from:
RpmKeys
val rpmConflicts: SettingKey[Seq[String]]

Attributes

Inherited from:
RpmKeys
val rpmDependencies: SettingKey[RpmDependencies]

Attributes

Inherited from:
RpmKeys
val rpmDescription: SettingKey[RpmDescription]

Attributes

Inherited from:
RpmKeys
val rpmDistribution: SettingKey[Option[String]]

Attributes

Inherited from:
RpmKeys
val rpmEpoch: SettingKey[Option[Int]]

Attributes

Inherited from:
RpmKeys
val rpmGroup: SettingKey[Option[String]]

Attributes

Inherited from:
RpmKeys
val rpmIcon: SettingKey[Option[String]]

Attributes

Inherited from:
RpmKeys
val rpmLicense: SettingKey[Option[String]]

Attributes

Inherited from:
RpmKeys
val rpmLint: TaskKey[Unit]

Attributes

Inherited from:
RpmKeys
val rpmMetadata: SettingKey[RpmMetadata]

Attributes

Inherited from:
RpmKeys
val rpmObsoletes: SettingKey[Seq[String]]

Attributes

Inherited from:
RpmKeys
val rpmOs: SettingKey[String]

Attributes

Inherited from:
RpmKeys
val rpmPackager: SettingKey[Option[String]]

Attributes

Inherited from:
RpmKeys
val rpmPrefix: SettingKey[Option[String]]

Attributes

Inherited from:
RpmKeys
val rpmPrerequisites: SettingKey[Seq[String]]

Attributes

Inherited from:
RpmKeys
val rpmProvides: SettingKey[Seq[String]]

Attributes

Inherited from:
RpmKeys
val rpmRelease: SettingKey[String]

Attributes

Inherited from:
RpmKeys
val rpmRequirements: SettingKey[Seq[String]]

Attributes

Inherited from:
RpmKeys
val rpmScripts: TaskKey[RpmScripts]

Attributes

Inherited from:
RpmKeys
val rpmScriptsDirectory: SettingKey[File]

Attributes

Inherited from:
RpmKeys
val rpmSetarch: SettingKey[Option[String]]

Attributes

Inherited from:
RpmKeys
val rpmSpecConfig: TaskKey[RpmSpec]

Attributes

Inherited from:
RpmKeys
val rpmUrl: SettingKey[Option[String]]

Attributes

Inherited from:
RpmKeys
val rpmVendor: SettingKey[String]

Attributes

Inherited from:
RpmKeys
val scriptClasspath: TaskKey[Seq[String]]

Attributes

Inherited from:
JavaAppKeys
val scriptClasspathOrdering: TaskKey[Seq[(FileRef, String)]]

Attributes

Inherited from:
JavaAppKeys
val serverLoading: SettingKey[Option[ServerLoader]]

Attributes

Inherited from:
SystemloaderKeys
val serviceAutostart: SettingKey[Boolean]

Attributes

Inherited from:
SystemloaderKeys
val stage: TaskKey[File]

Attributes

Inherited from:
UniversalKeys
val stagingDirectory: SettingKey[File]

Attributes

Inherited from:
UniversalKeys
val startRunlevels: SettingKey[Option[String]]

Attributes

Inherited from:
SystemloaderKeys
val stopRunlevels: SettingKey[Option[String]]

Attributes

Inherited from:
SystemloaderKeys
val termTimeout: SettingKey[Int]

Attributes

Inherited from:
SystemloaderKeys
val topLevelDirectory: SettingKey[Option[String]]

Attributes

Inherited from:
UniversalKeys
val universalArchiveOptions: SettingKey[Seq[String]]

Attributes

Inherited from:
UniversalKeys
val validatePackage: TaskKey[Unit]

A task that implements various validations for a format. Example usage:

A task that implements various validations for a format. Example usage:

  • sbt Universal/packageBin/validatePackage
  • sbt Debian/packageBin/validatePackage

Each format should implement it's own validate. Implemented in #1026

Attributes

Inherited from:
ValidationKeys
val validatePackageValidators: TaskKey[Seq[Validator]]

Attributes

Inherited from:
ValidationKeys
val wixConfig: TaskKey[Node]

Attributes

Inherited from:
WindowsKeys
val wixFeatures: TaskKey[Seq[WindowsFeature]]

Attributes

Inherited from:
WindowsKeys
val wixFiles: TaskKey[Seq[File]]

Attributes

Inherited from:
WindowsKeys
val wixMajorVersion: SettingKey[Int]

Attributes

Inherited from:
WindowsKeys
val wixPackageInfo: SettingKey[WindowsProductInfo]

Attributes

Inherited from:
WindowsKeys
val wixProductConfig: TaskKey[Node]

Attributes

Inherited from:
WindowsKeys
val wixProductId: SettingKey[String]

Attributes

Inherited from:
WindowsKeys
val wixProductLicense: TaskKey[Option[File]]

Attributes

Inherited from:
WindowsKeys
val wixProductUpgradeId: SettingKey[String]

Attributes

Inherited from:
WindowsKeys

Deprecated and Inherited fields

val debianExplodedPackage: TaskKey[File]

Attributes

Deprecated
[Since version 1.2.0] Use Debian/stage instead
Inherited from:
DebianKeys
val debianMaintainerScripts: TaskKey[Seq[(File, String)]]

Attributes

Deprecated
[Since version 1.0.3] Use generic maintainerScript task instead
Inherited from:
DebianKeys
val debianMakePostinstScript: TaskKey[Option[File]]

Attributes

Deprecated
[Since version 1.0.3] Use generic maintainerScript task instead
Inherited from:
DebianKeys
val debianMakePostrmScript: TaskKey[Option[File]]

Attributes

Deprecated
[Since version 1.0.3] Use generic maintainerScript task instead
Inherited from:
DebianKeys
val debianMakePreinstScript: TaskKey[Option[File]]

Attributes

Deprecated
[Since version 1.0.3] Use generic maintainerScript task instead
Inherited from:
DebianKeys
val debianMakePrermScript: TaskKey[Option[File]]

Attributes

Deprecated
[Since version 1.0.3] Use generic maintainerScript task instead
Inherited from:
DebianKeys
val rpmDaemonLogFile: SettingKey[String]

Attributes

Deprecated
[Since version 1.1.x] Use daemonStdoutLogFile instead
Inherited from:
RpmKeys
val rpmPost: SettingKey[Option[String]]

Attributes

Deprecated
[Since version 1.1.x] Use maintainerScripts in RPM and RpmConstants.Post instead.
Inherited from:
RpmKeys
val rpmPosttrans: SettingKey[Option[String]]

Attributes

Deprecated
[Since version 1.1.x] Use maintainerScripts in RPM and RpmConstants.Posttrans instead.
Inherited from:
RpmKeys
val rpmPostun: SettingKey[Option[String]]

Attributes

Deprecated
[Since version 1.1.x] Use maintainerScripts in RPM and RpmConstants.Postun instead.
Inherited from:
RpmKeys
val rpmPre: SettingKey[Option[String]]

Attributes

Deprecated
[Since version 1.1.x] Use maintainerScripts in RPM and RpmConstants.Pre instead.
Inherited from:
RpmKeys
val rpmPretrans: SettingKey[Option[String]]

Attributes

Deprecated
[Since version 1.1.x] Use maintainerScripts in RPM and RpmConstants.Pretrans instead.
Inherited from:
RpmKeys
val rpmPreun: SettingKey[Option[String]]

Attributes

Deprecated
[Since version 1.1.x] Use maintainerScripts in RPM and RpmConstants.Preun instead.
Inherited from:
RpmKeys
val rpmVerifyscript: SettingKey[Option[String]]

Attributes

Deprecated
[Since version 1.1.x] Use maintainerScripts in RPM and RpmConstants.Verifyscript instead.
Inherited from:
RpmKeys
val wixFile: TaskKey[File]

Attributes

Deprecated
[Since version 1.3.15] Use wixFiles task instead
Inherited from:
WindowsKeys
Generated with